mirror of
https://github.com/terribleplan/next.js.git
synced 2024-01-19 02:48:18 +00:00
4cab5228a0
* gh-page-exemple * add babelrc for gh-page exemple * Fix example (exemple in fr) * example fix typo * lint fix
58 lines
1.2 KiB
Markdown
58 lines
1.2 KiB
Markdown
# gh-pages Hello World example
|
|
|
|
## How to use
|
|
|
|
### Download manually
|
|
|
|
Download the example [or clone the repo](https://github.com/zeit/next.js):
|
|
|
|
```bash
|
|
curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/gh-pages
|
|
cd gh-pages
|
|
```
|
|
|
|
Install it and run:
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Deploy it to github
|
|
|
|
Edit ```env-config.js``` and replace ```'Next-gh-page-example'``` by your project name.
|
|
|
|
Edit ```next.config.js``` and replace ```'Next-gh-page-example'``` by your project name.
|
|
|
|
1. Create repository.
|
|
2. Link it to your github account.
|
|
3. Publish your master branch.
|
|
|
|
```bash
|
|
npm run deploy
|
|
```
|
|
|
|
Test it:
|
|
|
|
Reaplce 'github-user-name' and 'github-projet-name'
|
|
|
|
```bash
|
|
|
|
https://github-user-name.github.io/github-projet-name/
|
|
|
|
```
|
|
|
|
Example:
|
|
|
|
```bash
|
|
|
|
https://github.com/thierryc/Next-gh-page-example/
|
|
|
|
https://thierryc.github.io/Next-gh-page-example/
|
|
|
|
```
|
|
|
|
## The idea behind the example
|
|
|
|
This example shows the most basic idea behind Next. We have 2 pages: `pages/index.js` and `pages/about.js`. The former responds to `/` requests and the latter to `/about`. Using `next/link` you can add hyperlinks between them with universal routing capabilities.
|