hanzoai/next.js

Fork 0

mirror of https://github.com/hanzoai/next.js.git synced 2026-09-24 17:00:51 +00:00

Files

T

History

18faa9f114 Update examples/github-pages/README.md (#70057 )

Hi there,

I was trying to understand how to use
[examples/github-pages](https://github.com/vercel/next.js/tree/canary/examples/github-pages)
and when I followed the instructions my page was rendering without
stylesheets.

I found the extant README content to be clear, but after I found
https://github.com/vercel/next.js/discussions/38777 I was able to
understand what the current content meant, so I thought it would be
helpful to add this to the original example.

Open to edits on content or clarity.

Thanks!

---------

Co-authored-by: JJ Kasper <[email protected]>

2024-09-16 19:35:21 +00:00

app

chore(examples): use default prettier for examples/templates (#60530 )

2024-01-11 16:01:44 -07:00

.gitignore

Add .yarn/install-state.gz to .gitignore (#56637 )

2023-10-18 16:34:48 +00:00

next-env.d.ts

fix(create-next-app): link to app dir docs in next-env.d.ts in app dir templates (#68534 )

2024-08-09 22:21:28 +00:00

next.config.js

chore(examples): use default prettier for examples/templates (#60530 )

2024-01-11 16:01:44 -07:00

package.json

Use App Router for static export example. (#47584 )

2023-03-27 23:11:47 +00:00

README.md

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

2024-09-16 19:35:21 +00:00

tsconfig.json

Use App Router for static export example. (#47584 )

2023-03-27 23:11:47 +00:00

README.md

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:
- Given the pattern https://github.com/<user>/<repo>, update your basePath config to /repo.
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 > 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>/