Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Update examples/github-pages/README.md #70057

Merged
merged 4 commits into from
Sep 16, 2024
Merged

Update examples/github-pages/README.md #70057

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b689972
Update examples/github-pages/README.md
brekk Sep 13, 2024
2c31d53
Merge branch 'canary' into patch-2
brekk Sep 13, 2024
eb5694a
Apply suggestions from code review
ijjk Sep 16, 2024
9ef26dd
lint-fix
ijjk Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion examples/github-pages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ 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. Edit `next.config.js` to match your GitHub repository name:
- Given the pattern `https://github.com/<user>/<repo>`, update your `basePath` config to `/repo`.
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.
1. On GitHub, go to **Settings** > **Pages** > **Branch**, and choose `gh-pages` as the branch with the `/root` folder. Hit **Save**.
Expand Down
Loading