36eba95227
* copy cleanup in env. variables docs * copy cleanup in fast refresh docs * Supplements #33153 - updating existing cross-references to `master` branch to renamed default branch of `main` * Supplements #33153 - updating existing cross-references to `master` branch to renamed default branch of `main` Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| pages | ||
| .babelrc.js | ||
| .gitignore | ||
| env-config.js | ||
| next.config.js | ||
| package.json | ||
| README.md | ||
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.
- Create repository.
- Link it to your github account.
- Publish your default branch, e.g.
main.
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/