Marcos Bérgamo
c3e5caf110
docs(examples): improve DX while copying command to create new project ( #38410 )
...
* docs(examples): improve DX while copy command to create new project
* chore: apply code review
Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-26 21:57:48 -05:00
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
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
Rishi Raj Jain
92fc260e4c
Update README.md ( #17347 )
...
As clear from [#14233 ](https://github.com/vercel/next.js/pull/14233#issuecomment-645997757 ) that the 'with-algolia example is not SSR', I've updated the documentation to clear the confusion caused, as visible in #17229
Fixes #17229
2020-09-25 01:55:11 +00:00
Luis Alvarez D
4162e39696
Undo unrequired readme changes done to examples ( #16831 )
...
Related to https://github.com/vercel/next.js/pull/16678#issuecomment-684962496
2020-09-03 19:11:58 +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
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
Matthew Sweeney
0cd2732c7f
Remove deploy to now button from all examples ( #7101 )
2019-05-27 12:22:05 -07: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
k-kawakami
d9060f5abd
Remove trailing spaces ( #6547 )
...
### changes
#### remove trailing spaces
When I was using example I noticed trailing spaces.
So, this PR removes the trailing spaces of json file, README, and others.
`examples/with-jest-typescript/src/modules/cars/Overview.tsx` also has it, but this time it did not change as tslint error occurs at commit.
2019-03-07 17:40:08 +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
James Hegedus
f2e56609cd
Examples: stabalise README format and create-next-app usage ( #4009 )
...
* Examples: clarify language around Yarn create & npx
* add missing READMEs and create-next-app usage
* suggest people tag jthegedus in firebase related issues
* add yarn alt instructions
* cerebraljs example readme & fixes
2018-04-03 14:19:05 +02:00
James Hegedus
b1d8b839dd
Examples: use npx and yarn create to run create-next-app on examples ( #4002 )
...
* remove global npm install of create-next-app
* add npx to create-next-app command in examples
* add bash to shell snippets
* add yarn create to next-app command in examples
* fix READMEs named with lowercase
* change READMEs to use UPPERCASE
2018-03-14 09:09:46 +01:00
Tim Neutkens
24c1ac6ca9
Use canary for all example downloads ( #3411 )
2017-12-06 18:12:42 -08:00
Fouad Matin
2528779394
examples: add create-next-app ( #3377 )
...
* examples: add create-next-app
* fix with-typescript readme
2017-12-02 20:30:17 -08:00
Marie-Laure Thuret
94c484e80d
docs: add algolia-react-instantsearch example ( #2544 )
...
* docs: add algolia-react-instantsearch example
* fix: style
2017-07-12 20:00:47 +02:00