Steven
57dcc9d329
Update pnpm create next-app
for latest pnpm 6 and 7 ( #37254 )
...
This command changed in pnpm [6.32.13](https://github.com/pnpm/pnpm/releases/tag/v6.32.13 ) and [7.1.1](https://github.com/pnpm/pnpm/releases/tag/v7.1.1 ) so lets update it since its been a few weeks and we can expect pnpm users to update more regularly than npm users.
- Fixes https://github.com/vercel/next.js/pull/37240
- Fixes https://github.com/vercel/next.js/pull/37045
- Fixes https://github.com/vercel/next.js/pull/37032
- Fixes https://github.com/vercel/next.js/pull/36602
- Fixes https://github.com/vercel/next.js/pull/36496
2022-05-27 21:21:40 +00:00
Tom
3e178bb801
add pnpm link to docs ( #37221 )
...
## Documentation / Examples
- [x] Make sure the linting passes by running `yarn lint`
- [ ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples )
Co-authored-by: Steven <steven@ceriously.com>
2022-05-27 15:46:38 -04:00
Steven
9f9214abe5
Updated create-next-app docs to include pnpm usage ( #35755 )
...
This PR updates the docs and examples for `create-next-app` to include pnpm usage.
The following script was used to update every example README:
```js
const fs = require('fs')
const examples = fs.readdirSync('./examples')
for (let example of examples) {
const filename = `./examples/${example}/README.md`
const markdown = fs.readFileSync(filename, 'utf8')
const regex = new RegExp(`^yarn create next-app --example (.*)$`, 'gm')
const output = markdown.replace(regex, (yarn, group) => {
const pnpm = `pnpm create next-app -- --example ${group}`
return `${yarn}\n# or\n${pnpm}`
})
fs.writeFileSync(filename, output)
}
```
2022-03-30 21:03:21 +00:00
Hassan El Mghari
33aa51ab26
Change README structure in examples ( #35349 )
...
Changed the README structure in all examples to take out the Stackblitz button and include it as a link instead using a [bash script](https://gist.github.com/Nutlope/a8f3556a5a401e32a8c6278b782ebf8a/revisions ).
I also added the Vercel deploy button to 15 READMEs that didn't have it.
2022-03-16 21:39:26 +00:00
Ikko Ashimine
a1dc5588c2
docs: fix typo in with-unstated/README.md ( #26004 )
...
resetted -> reset
2021-06-11 14:12:50 +00:00
Dominic Elm
d2caaeab64
docs: add 'Open in StackBlitz' buttons to various examples ( #25853 )
...
This PR adds a `Preview` section and a `Open in StackBlitz` button to various examples. I have tested all examples and omitted the ones that require third party API keys, or didn't work. Some examples don't work locally either.
Here's an example:
![image](https://user-images.githubusercontent.com/12571019/121027783-88971280-c7a7-11eb-851a-0ad30cf74b42.png )
## Bug
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
## 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`
- [ ] Integration tests added
- [ ] Documentation added
- [x] Examples updated
- [ ] Telemetry added. In case of a feature if it's used or not.
## Documentation / Examples
- [x] Make sure the linting passes
2021-06-08 20:45:02 +00:00
Luis Alvarez D
e28fd50441
Include utm_source on example links to vercel.com ( #21305 )
2021-01-19 07:28:54 +00:00
Luc Leray
8eaabe2fb0
Fix deploy buttons URLs ( #20834 )
...
Fix all deploy button URLs in the Next.js repo to follow the following format:
```
https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/ <EXAMPLE_NAME>&project-name=<EXAMPLE_NAME>&repository-name=<EXAMPLE_NAME>
```
The detailed docs for the Deploy Button can be found here: https://vercel.com/docs/more/deploy-button .
Also updates legacy Vercel import flow URLs (starting with vercel.com/import or with vercel.com/new/project), to use the new vercel.com/new URLs.
---
For example, for the `hello-world` example:
The URL is https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/hello-world&project-name=hello-world&repository-name=hello-world
And the deploy button looks like this:
[![Deploy with Vercel](https://vercel.com/button )](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/hello-world&project-name=hello-world&repository-name=hello-world )
---
For reference, I used the following regexes to search for the incorrect URLs
```
\(https://vercel.com/import/git\?s=https://github.com/vercel/next.js/tree/canary/examples/(.*) \)
\(https://vercel.com/import/git\?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/ ([^&]*)(.*)\)
\(https://vercel.com/import/project\?template=https://github.com/vercel/next.js/tree/canary/examples/(.*) \)
https://vercel.com/import/git
https://vercel.com/import/select-scope
https://vercel.com/import
https://vercel.com/new/project
```
2021-01-07 01:40:29 +00:00
NorbertLuszkiewicz
c03d4931de
Simplify example usage instructions ( #16678 )
...
Co-authored-by: Joe Haddad <joe.haddad@zeit.co>
2020-08-29 22:22:02 -04:00
Joe Haddad
7d038dfef1
Suggest npx
over npm init
( #13637 )
...
This updates old examples to the more universal `npx` command.
Fixes https://github.com/vercel/next.js/discussions/12103
2020-06-01 17:36:57 +00:00
Joe Haddad
b7e17e09e5
Update references to zeit/next.js ( #13463 )
2020-05-27 17:51:11 -04:00
JJ Kasper
1f6ce106ae
Update codeload and deploy links for org rename ( #13141 )
...
Co-authored-by: Joe Haddad <joe.haddad@zeit.co>
2020-05-27 14:11:39 -04:00
Tim Neutkens
483bd3ddda
Rename ZEIT to Vercel ( #12075 )
...
* Find/replace
* Update more URLs
* More rename
* Fix remaining examples
* More updates
* Update create-next-app
* Update remaining text
* Update
Co-authored-by: Shu Uesugi <shu@chibicode.com>
2020-04-21 11:47:12 +02:00
Luis Alvarez D
1992e2a96e
Example/update unstated ( #11534 )
...
* Updated components and deps
* Updated readme
2020-04-01 11:36:02 +02:00
Shu Uesugi
c57cdbb31d
Rename zeit.co/new → zeit.co/import ( #10674 )
...
* Replace zeit.co/new → zeit.co/import
* Update deployment.md
2020-02-24 19:08:34 -05:00
Shu Uesugi
5f041447bc
Remove Now CLI reference from examples ( #10501 )
...
* Find/Replace "Deploy it to the cloud..."
* Find/Replace "Deploy it to the cloud..." (no colon)
* Find/Replace "Deploy it to the cloud..." for firebase
* Convert remaining ones
* Storybook deployment
* Update with-stripe-typescript
* Update contributing.md
* Remove `now`
* Update examples/with-stripe-typescript/README.md
Co-Authored-By: Luis Alvarez D. <luis@zeit.co>
2020-02-12 17:14:57 -05:00
Shu Uesugi
6804039e94
Make example READMEs more consistent ( #10124 )
...
* npx create → npm init
* Fix inconsistent instructions
* Update amp-first
* Update with-graphql-react
* with-firebase-cloud-messaging
* Update with-higher-order-component
* change create-next-app url
* Update create-next-app instruction
* Update instructions to use npm instead of npx
* Move "the idea behind the example" to top
* Rename
* Rename
* Update contributing.md with a README template
2020-01-16 23:23:56 +01:00
Luis Alvarez D
7edf0da0c4
Add the deploy button to compatible examples ( #9547 )
2019-11-27 11:40:58 -05:00
Luis Alvarez D
f10f3304fe
Replace the deprecated Create Next App URL ( #9032 )
2019-10-10 23:34:14 -04:00
Connor Davis
3fa04620e7
Remove Deploy To Now buttons ( #7126 )
...
* Remove Deploy To Now buttons
* Remove remaining buttons
2019-04-24 10:53:58 +02:00
tylim
5d8ae4456e
improve with-unstated example ( #5998 )
...
improve the example so that it can preserve unstated from server to client unstated
2019-01-06 16:58:06 +01:00
tylim
81cfea7d90
improve Unstated example so that it can shares state when switching pages ( #5822 )
...
* add new example
* update gitignore
* fix lint
* fix linting
* fix linting again
* update unstated example
* remove unsued var
* update readme
2018-12-05 11:32:45 +01:00
Michael Herold
5b3578e58f
#4751 - Explicitly mention install when cloning examples ( #4758 )
...
Preferably this installation wouldn't be necessary, but in lieu of a fix...
#4751
2018-07-11 23:56:15 +02:00
Bünyamin Benny Genel
67cb87adb5
Added with-unstated example ( #4628 )
...
Small example app using [unstated](https://github.com/jamiebuilds/unstated ) library. Example uses components and logic from [with-redux](https://github.com/zeit/next.js/tree/canary/examples/with-redux ) example.
2018-06-19 21:50:37 +02:00