History

Henrik Wenz 92aafcbcf1 [Docs] Add config types to all examples (#40083 ) <!-- Thanks for opening a PR! Your contribution is much appreciated. In order to make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change that you're making: --> ## Summary - Added jsdoc typing for all examples using `next.config.js` - Added jsdoc typing for all examples using `tailwind.config.js` ## Documentation / Examples - [x] Make sure the linting passes by running `pnpm lint` - [x] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)		2022-08-31 16:41:22 -05:00
..
pages	Update GitHub Pages deployment example. (#37282 )	2022-05-29 20:12:37 +00:00
.gitignore	Update default gitignore templates (#39051 )	2022-07-26 20:08:40 -05:00
next.config.js	[Docs] Add config types to all examples (#40083 )	2022-08-31 16:41:22 -05:00
package.json	Update GitHub Pages deployment example. (#37282 )	2022-05-29 20:12:37 +00:00
README.md	Update GitHub Pages deployment example. (#37282 )	2022-05-29 20:12:37 +00:00

README.md

Deploying to GitHub Pages

This example supports deloying a static Next.js application (using next export) to GitHub Pages.

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 the gh-pages branch.
On GitHub, go to Settings > Pages > Source, 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>/