Commit Graph

7 Commits

Author SHA1 Message Date
Jam Balaya 49cba424e8 examples: polish some README.md (#72117)
## Description
I have corrected some mistakes according to the [contribution
guide](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md).

1. Update `create-next-app` script
2. Remove redundant new line, space and double colon
3. `readme.md` → `README.md`

### Adding or Updating Examples

- [x] The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- [x] Make sure the linting passes by running `pnpm build && pnpm lint`.
See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

---------

Co-authored-by: Sam Ko <sam@vercel.com>
2024-11-13 18:52:56 +00:00
Brekk 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 <jj@jjsweb.site>
2024-09-16 19:35:21 +00:00
Felipe Oliveira 46677ccda6 fix: (README.md) Fix typing error (#53311)
Fix typing error on documentation where 'deploying' it was written as 'deloying'
2023-07-28 20:43:43 +00:00
Lee Robinson 7c44cf0a3b Use App Router for static export example. (#47584)
To aid the new docs, stable static export in the next release.

https://beta.nextjs.org/docs/configuring/static-export
2023-03-27 23:11:47 +00:00
labyrinthitis af0ac941de corrected /examples/github-pages readme (#43766)
`branch` is the correct subheading direction; the `source` subheading represents `deploying from a branch` or from a `github action`



## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md)

## Documentation / Examples

- [ ] Make sure the linting passes by running `pnpm build && pnpm lint`
- [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2022-12-12 02:33:38 +00:00
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
Lee Robinson c4fdfcb7f1 Update GitHub Pages deployment example. (#37282)
Verified it's working: https://leerob.github.io/gh-pages-test/
2022-05-29 20:12:37 +00:00