rsnext/examples/gh-pages
2020-08-29 22:32:35 -04:00
..
pages Update Examples for Fast Refresh (#13068) 2020-05-18 17:44:18 -04:00
.babelrc.js Improve linting rules to catch more errors (#9374) 2019-11-10 19:24:53 -08:00
.gitignore Fix gh-pages deploy script (#15724) 2020-07-31 16:25:17 +00:00
env-config.js Improve linting rules to catch more errors (#9374) 2019-11-10 19:24:53 -08:00
next.config.js Remove unnecessary exportPathMap from examples (#10218) 2020-01-22 22:06:07 +01:00
package.json Ensure all examples are MIT licensed (#16691) 2020-08-29 22:32:35 -04:00
README.md Simplify example usage instructions (#16678) 2020-08-29 22:22:02 -04:00

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

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example gh-pages gh-pages-app
# or
yarn create next-app --example gh-pages gh-pages-app

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.
npm run deploy

Test it:

Replace <github-user-name> and <github-project-name>

https://<github-user-name>.github.io/<github-project-name>/

Example:

https://github.com/thierryc/Next-gh-page-example/

https://thierryc.github.io/Next-gh-page-example/