2022-05-29 22:12:37 +02:00
# Deploying to GitHub Pages
2023-07-28 22:43:43 +02:00
This example supports deploying a statically exported Next.js application to GitHub Pages.
2022-05-29 22:12:37 +02:00
2022-10-26 22:28:55 +02:00
The `out` directory should not be ignored by version control.
2022-05-29 22:12:37 +02:00
## How to use
Execute [`create-next-app` ](https://github.com/vercel/next.js/tree/canary/packages/create-next-app ) with [npm ](https://docs.npmjs.com/cli/init ), [Yarn ](https://yarnpkg.com/lang/en/docs/cli/create/ ), or [pnpm ](https://pnpm.io ) to bootstrap the example:
```bash
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
1. Create a new public GitHub repository.
1. Edit `next.config.js` to match your GitHub repository name.
1. Push the starter code to the `main` branch.
1. Run the `deploy` script (e.g. `npm run deploy` ) to create the `gh-pages` branch.
2022-12-12 03:33:38 +01:00
1. On GitHub, go to **Settings** > **Pages** > **Branch** , and choose `gh-pages` as the branch with the `/root` folder. Hit **Save** .
2022-05-29 22:12:37 +02:00
1. Make a change.
1. Run the `deploy` script again to push the changes to GitHub Pages.
Congratulations! You should have a URL like:
```bash
https://< github-user-name > .github.io/< github-project-name > /
```