f52955ec94
Clean up package.json files in the `examples` directory: - Add `private: true` - Remove `version` (because they are irrelevant for packages that are not meant to be published) - Remove `name` (because they are optional for packages that are not meant to be published, and when someone clones an example, they often rename it and the property becomes stale) - Remove `author` - Remove `description` - Remove `license` Also remove `with-dynamic-app-layout` example completely, since it does the same as `layout-component` (https://github.com/vercel/next.js/pull/27121#discussion_r668178408). ## Documentation / Examples - [x] Make sure the linting passes |
||
---|---|---|
.. | ||
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 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/