archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rsnext/examples/github-pages
History
Max Proske 5dd4999b64
Convert many examples to TypeScript (#41825) 
Strategized with @balazsorban44 to open one larger PR, with changes to individual examples as separate commits. 

For each example, I researched how multiple realworld codebases use the featured technology with TypeScript, to thoughtfully convert them by hand - nothing automated whatsoever.

## 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/examples/adding-examples.md)
2022-10-26 20:28:55 +00:00
..
pages Convert many examples to TypeScript (#41825) 2022-10-26 20:28:55 +00:00
.gitignore Convert many examples to TypeScript (#41825) 2022-10-26 20:28:55 +00:00
next.config.js Convert many examples to TypeScript (#41825) 2022-10-26 20:28:55 +00:00
package.json Convert many examples to TypeScript (#41825) 2022-10-26 20:28:55 +00:00
README.md Convert many examples to TypeScript (#41825) 2022-10-26 20:28:55 +00:00
tsconfig.json Convert many examples to TypeScript (#41825) 2022-10-26 20:28:55 +00:00

README.md

Deploying to GitHub Pages

This example supports deloying a static Next.js application (using next export) 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

  1. Create a new public GitHub repository.
  2. Edit next.config.js to match your GitHub repository name.
  3. Push the starter code to the main branch.
  4. Run the deploy script (e.g. npm run deploy) to create the gh-pages branch.
  5. On GitHub, go to Settings > Pages > Source, and choose gh-pages as the branch with the /root folder. Hit Save.
  6. Make a change.
  7. 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>/