6804039e94
* npx create → npm init * Fix inconsistent instructions * Update amp-first * Update with-graphql-react * with-firebase-cloud-messaging * Update with-higher-order-component * change create-next-app url * Update create-next-app instruction * Update instructions to use npm instead of npx * Move "the idea behind the example" to top * Rename * Rename * Update contributing.md with a README template
64 lines
1.5 KiB
Markdown
64 lines
1.5 KiB
Markdown
# gh-pages Hello World 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.
|
|
|
|
## How to use
|
|
|
|
### Using `create-next-app`
|
|
|
|
Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
|
|
|
```bash
|
|
npm init next-app --example gh-pages gh-pages-app
|
|
# or
|
|
yarn create next-app --example gh-pages gh-pages-app
|
|
```
|
|
|
|
### Download manually
|
|
|
|
Download the example:
|
|
|
|
```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
|
|
# or
|
|
yarn
|
|
yarn 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:
|
|
|
|
Replace `<github-user-name>` and `<github-project-name>`
|
|
|
|
```bash
|
|
https://<github-user-name>.github.io/<github-project-name>/
|
|
```
|
|
|
|
Example:
|
|
|
|
```bash
|
|
https://github.com/thierryc/Next-gh-page-example/
|
|
|
|
https://thierryc.github.io/Next-gh-page-example/
|
|
```
|