66597be8a7
### Reason for making this change https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again. In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited. ### Remaining work I apologize for only modifying one template initially to initiate the discussion first. If this change is agreed upon, it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change. |
||
---|---|---|
.. | ||
app | ||
.gitignore | ||
next-env.d.ts | ||
next.config.js | ||
package.json | ||
README.md | ||
tsconfig.json |
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.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>/