Skip to content

Commit c3e5caf

Browse files
thebergamoMarcos Bérgamoijjk
authored
docs(examples): improve DX while copying command to create new project (vercel#38410)
* docs(examples): improve DX while copy command to create new project * chore: apply code review Co-authored-by: Marcos Bérgamo <[email protected]> Co-authored-by: JJ Kasper <[email protected]>
1 parent 0ab6ad5 commit c3e5caf

File tree

252 files changed

+1512
-504
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

252 files changed

+1512
-504
lines changed

contributing.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -306,9 +306,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
306306

307307
```bash
308308
npx create-next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
309-
# or
309+
```
310+
311+
```bash
310312
yarn create next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
311-
# or
313+
```
314+
315+
```bash
312316
pnpm create next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
313317
```
314318

examples/active-class-name/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example active-class-name active-class-name-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example active-class-name active-class-name-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example active-class-name active-class-name-app
2125
```
2226

examples/amp-first/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1919

2020
```bash
2121
npx create-next-app --example amp-first amp-first-app
22-
# or
22+
```
23+
24+
```bash
2325
yarn create next-app --example amp-first amp-first-app
24-
# or
26+
```
27+
28+
```bash
2529
pnpm create next-app --example amp-first amp-first-app
2630
```
2731

examples/amp-story/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example amp-story amp-story-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example amp-story amp-story-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example amp-story amp-story-app
2125
```
2226

examples/amp/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example amp amp-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example amp amp-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example amp amp-app
2125
```
2226

examples/analyze-bundles/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example analyze-bundles analyze-bundles-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example analyze-bundles analyze-bundles-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example analyze-bundles analyze-bundles-app
2125
```
2226

examples/api-routes-apollo-server-and-client-auth/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1616

1717
```bash
1818
npx create-next-app --example api-routes-apollo-server-and-client-auth api-routes-apollo-server-and-client-auth-app
19-
# or
19+
```
20+
21+
```bash
2022
yarn create next-app --example api-routes-apollo-server-and-client-auth api-routes-apollo-server-and-client-auth-app
21-
# or
23+
```
24+
25+
```bash
2226
pnpm create next-app --example api-routes-apollo-server-and-client-auth api-routes-apollo-server-and-client-auth-app
2327
```
2428

examples/api-routes-apollo-server-and-client/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1616

1717
```bash
1818
npx create-next-app --example api-routes-apollo-server-and-client api-routes-apollo-server-and-client-app
19-
# or
19+
```
20+
21+
```bash
2022
yarn create next-app --example api-routes-apollo-server-and-client api-routes-apollo-server-and-client-app
21-
# or
23+
```
24+
25+
```bash
2226
pnpm create next-app --example api-routes-apollo-server-and-client api-routes-apollo-server-and-client-app
2327
```
2428

examples/api-routes-apollo-server/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example api-routes-apollo-server api-routes-apollo-server-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example api-routes-apollo-server api-routes-apollo-server-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example api-routes-apollo-server api-routes-apollo-server-app
2125
```
2226

examples/api-routes-cors/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1616

1717
```bash
1818
npx create-next-app --example api-routes-cors api-routes-cors-app
19-
# or
19+
```
20+
21+
```bash
2022
yarn create next-app --example api-routes-cors api-routes-cors-app
21-
# or
23+
```
24+
25+
```bash
2226
pnpm create next-app --example api-routes-cors api-routes-cors-app
2327
```
2428

examples/api-routes-graphql/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
3131

3232
```bash
3333
npx create-next-app --example api-routes-graphql api-routes-graphql-app
34-
# or
34+
```
35+
36+
```bash
3537
yarn create next-app --example api-routes-graphql api-routes-graphql-app
36-
# or
38+
```
39+
40+
```bash
3741
pnpm create next-app --example api-routes-graphql api-routes-graphql-app
3842
```
3943

examples/api-routes-middleware/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example api-routes-middleware api-routes-middleware-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example api-routes-middleware api-routes-middleware-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example api-routes-middleware api-routes-middleware-app
2125
```
2226

examples/api-routes-rate-limit/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
2828

2929
```bash
3030
npx create-next-app --example api-routes-rate-limit api-routes-rate-limit-app
31-
# or
31+
```
32+
33+
```bash
3234
yarn create next-app --example api-routes-rate-limit api-routes-rate-limit-app
33-
# or
35+
```
36+
37+
```bash
3438
pnpm create next-app --example api-routes-rate-limit api-routes-rate-limit-app
3539
```
3640

examples/api-routes-rest/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example api-routes-rest api-routes-rest-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example api-routes-rest api-routes-rest-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example api-routes-rest api-routes-rest-app
2125
```
2226

examples/api-routes/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example api-routes api-routes-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example api-routes api-routes-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example api-routes api-routes-app
2125
```
2226

examples/auth0/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1717

1818
```bash
1919
npx create-next-app --example auth0 auth0-app
20-
# or
20+
```
21+
22+
```bash
2123
yarn create next-app --example auth0 auth0-app
22-
# or
24+
```
25+
26+
```bash
2327
pnpm create next-app --example auth0 auth0-app
2428
```
2529

examples/basic-css/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example basic-css basic-css-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example basic-css basic-css-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example basic-css basic-css-app
2125
```
2226

examples/basic-export/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1414

1515
```bash
1616
npx create-next-app --example basic-export basic-export-app
17-
# or
17+
```
18+
19+
```bash
1820
yarn create next-app --example basic-export basic-export-app
19-
# or
21+
```
22+
23+
```bash
2024
pnpm create next-app --example basic-export basic-export-app
2125
```
2226

examples/blog-starter/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
4343

4444
```bash
4545
npx create-next-app --example blog-starter blog-starter-app
46-
# or
46+
```
47+
48+
```bash
4749
yarn create next-app --example blog-starter blog-starter-app
48-
# or
50+
```
51+
52+
```bash
4953
pnpm create next-app --example blog-starter blog-starter-app
5054
```
5155

examples/catch-all-routes/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
2323

2424
```bash
2525
npx create-next-app --example catch-all-routes catch-all-routes-app
26-
# or
26+
```
27+
28+
```bash
2729
yarn create next-app --example catch-all-routes catch-all-routes-app
28-
# or
30+
```
31+
32+
```bash
2933
pnpm create next-app --example catch-all-routes catch-all-routes-app
3034
```
3135

examples/cms-agilitycms/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
4040

4141
```bash
4242
npx create-next-app --example cms-agilitycms cms-agilitycms-app
43-
# or
43+
```
44+
45+
```bash
4446
yarn create next-app --example cms-agilitycms cms-agilitycms-app
45-
# or
47+
```
48+
49+
```bash
4650
pnpm create next-app --example cms-agilitycms cms-agilitycms-app
4751
```
4852

examples/cms-builder-io/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
1212

1313
```bash
1414
npx create-next-app --example cms-builder-io cms-builder-io-app
15-
# or
15+
```
16+
17+
```bash
1618
yarn create next-app --example cms-builder-io cms-builder-io-app
17-
# or
19+
```
20+
21+
```bash
1822
pnpm create next-app --example cms-builder-io cms-builder-io-app
1923
```
2024

examples/cms-buttercms/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
5353

5454
```bash
5555
npx create-next-app --example cms-buttercms cms-buttercms-app
56-
# or
56+
```
57+
58+
```bash
5759
yarn create next-app --example cms-buttercms cms-buttercms-app
58-
# or
60+
```
61+
62+
```bash
5963
pnpm create next-app --example cms-buttercms cms-buttercms-app
6064
```
6165

examples/cms-contentful/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
3737

3838
```bash
3939
npx create-next-app --example cms-contentful cms-contentful-app
40-
# or
40+
```
41+
42+
```bash
4143
yarn create next-app --example cms-contentful cms-contentful-app
42-
# or
44+
```
45+
46+
```bash
4347
pnpm create next-app --example cms-contentful cms-contentful-app
4448
```
4549

examples/cms-cosmic/README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag
3737

3838
```bash
3939
npx create-next-app --example cms-cosmic cms-cosmic-app
40-
# or
40+
```
41+
42+
```bash
4143
yarn create next-app --example cms-cosmic cms-cosmic-app
42-
# or
44+
```
45+
46+
```bash
4347
pnpm create next-app --example cms-cosmic cms-cosmic-app
4448
```
4549

0 commit comments

Comments
 (0)