mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
a9492ffa12
## Description At #72178, [TypeScript](https://nextjs.org/docs/app/api-reference/config/typescript) docs was moved. So update the old URLs. ### Improving Documentation - [x] Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - [x] Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide --------- Co-authored-by: Zack Tanner <[email protected]>
Deploying to GitHub Pages
This example supports deploying 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.jsto match your GitHub repository name:- Given the pattern
https://github.com/<user>/<repo>, update yourbasePathconfig to/repo.
- Given the pattern
- Push the starter code to the
mainbranch. - Run the
deployscript (e.g.npm run deploy) to create thegh-pagesbranch. - On GitHub, go to Settings > Pages > Branch, and choose
gh-pagesas the branch with the/rootfolder. Hit Save. - Make a change.
- Run the
deployscript again to push the changes to GitHub Pages.
Congratulations! You should have a URL like:
https://<github-user-name>.github.io/<github-project-name>/