7c44cf0a3b
To aid the new docs, stable static export in the next release. https://beta.nextjs.org/docs/configuring/static-export |
||
---|---|---|
.. | ||
app | ||
.gitignore | ||
next-env.d.ts | ||
next.config.js | ||
package.json | ||
README.md | ||
tsconfig.json |
Deploying to GitHub Pages
This example supports deloying a statically exported Next.js application to GitHub Pages.
The out
directory should not be ignored by version control.
How to use
Execute create-next-app
with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example github-pages nextjs-github-pages
# or
yarn create next-app --example github-pages nextjs-github-pages
# or
pnpm create next-app --example github-pages nextjs-github-pages
Deploy to GitHub Pages
- Create a new public GitHub repository.
- Edit
next.config.js
to match your GitHub repository name. - Push the starter code to the
main
branch. - Run the
deploy
script (e.g.npm run deploy
) to create thegh-pages
branch. - On GitHub, go to Settings > Pages > Branch, and choose
gh-pages
as the branch with the/root
folder. Hit Save. - Make a change.
- Run the
deploy
script again to push the changes to GitHub Pages.
Congratulations! You should have a URL like:
https://<github-user-name>.github.io/<github-project-name>/