9f9214abe5
This PR updates the docs and examples for `create-next-app` to include pnpm usage. The following script was used to update every example README: ```js const fs = require('fs') const examples = fs.readdirSync('./examples') for (let example of examples) { const filename = `./examples/${example}/README.md` const markdown = fs.readFileSync(filename, 'utf8') const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm') const output = markdown.replace(regex, (yarn, group) => { const pnpm = `pnpm create next-app -- --example ${group}` return `${yarn}\n# or\n${pnpm}` }) fs.writeFileSync(filename, output) } ``` |
||
---|---|---|
.. | ||
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
# or
pnpm 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/