Skip to content

Commit

Permalink
docs(examples): improve DX while copying command to create new project (
Browse files Browse the repository at this point in the history
#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>
  • Loading branch information
3 people committed Jul 27, 2022
1 parent 0ab6ad5 commit c3e5caf
Show file tree
Hide file tree
Showing 252 changed files with 1,512 additions and 504 deletions.
8 changes: 6 additions & 2 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,9 +306,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
# or
```

```bash
yarn create next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
# or
```

```bash
pnpm create next-app --example DIRECTORY_NAME DIRECTORY_NAME-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/active-class-name/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example active-class-name active-class-name-app
# or
```

```bash
yarn create next-app --example active-class-name active-class-name-app
# or
```

```bash
pnpm create next-app --example active-class-name active-class-name-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/amp-first/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example amp-first amp-first-app
# or
```

```bash
yarn create next-app --example amp-first amp-first-app
# or
```

```bash
pnpm create next-app --example amp-first amp-first-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/amp-story/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example amp-story amp-story-app
# or
```

```bash
yarn create next-app --example amp-story amp-story-app
# or
```

```bash
pnpm create next-app --example amp-story amp-story-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/amp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example amp amp-app
# or
```

```bash
yarn create next-app --example amp amp-app
# or
```

```bash
pnpm create next-app --example amp amp-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/analyze-bundles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example analyze-bundles analyze-bundles-app
# or
```

```bash
yarn create next-app --example analyze-bundles analyze-bundles-app
# or
```

```bash
pnpm create next-app --example analyze-bundles analyze-bundles-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-apollo-server-and-client-auth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-apollo-server-and-client-auth api-routes-apollo-server-and-client-auth-app
# or
```

```bash
yarn create next-app --example api-routes-apollo-server-and-client-auth api-routes-apollo-server-and-client-auth-app
# or
```

```bash
pnpm create next-app --example api-routes-apollo-server-and-client-auth api-routes-apollo-server-and-client-auth-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-apollo-server-and-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-apollo-server-and-client api-routes-apollo-server-and-client-app
# or
```

```bash
yarn create next-app --example api-routes-apollo-server-and-client api-routes-apollo-server-and-client-app
# or
```

```bash
pnpm create next-app --example api-routes-apollo-server-and-client api-routes-apollo-server-and-client-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-apollo-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-apollo-server api-routes-apollo-server-app
# or
```

```bash
yarn create next-app --example api-routes-apollo-server api-routes-apollo-server-app
# or
```

```bash
pnpm create next-app --example api-routes-apollo-server api-routes-apollo-server-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-cors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-cors api-routes-cors-app
# or
```

```bash
yarn create next-app --example api-routes-cors api-routes-cors-app
# or
```

```bash
pnpm create next-app --example api-routes-cors api-routes-cors-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-graphql api-routes-graphql-app
# or
```

```bash
yarn create next-app --example api-routes-graphql api-routes-graphql-app
# or
```

```bash
pnpm create next-app --example api-routes-graphql api-routes-graphql-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-middleware/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-middleware api-routes-middleware-app
# or
```

```bash
yarn create next-app --example api-routes-middleware api-routes-middleware-app
# or
```

```bash
pnpm create next-app --example api-routes-middleware api-routes-middleware-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-rate-limit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-rate-limit api-routes-rate-limit-app
# or
```

```bash
yarn create next-app --example api-routes-rate-limit api-routes-rate-limit-app
# or
```

```bash
pnpm create next-app --example api-routes-rate-limit api-routes-rate-limit-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes-rest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes-rest api-routes-rest-app
# or
```

```bash
yarn create next-app --example api-routes-rest api-routes-rest-app
# or
```

```bash
pnpm create next-app --example api-routes-rest api-routes-rest-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/api-routes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example api-routes api-routes-app
# or
```

```bash
yarn create next-app --example api-routes api-routes-app
# or
```

```bash
pnpm create next-app --example api-routes api-routes-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/auth0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example auth0 auth0-app
# or
```

```bash
yarn create next-app --example auth0 auth0-app
# or
```

```bash
pnpm create next-app --example auth0 auth0-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/basic-css/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example basic-css basic-css-app
# or
```

```bash
yarn create next-app --example basic-css basic-css-app
# or
```

```bash
pnpm create next-app --example basic-css basic-css-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/basic-export/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example basic-export basic-export-app
# or
```

```bash
yarn create next-app --example basic-export basic-export-app
# or
```

```bash
pnpm create next-app --example basic-export basic-export-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/blog-starter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example blog-starter blog-starter-app
# or
```

```bash
yarn create next-app --example blog-starter blog-starter-app
# or
```

```bash
pnpm create next-app --example blog-starter blog-starter-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/catch-all-routes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example catch-all-routes catch-all-routes-app
# or
```

```bash
yarn create next-app --example catch-all-routes catch-all-routes-app
# or
```

```bash
pnpm create next-app --example catch-all-routes catch-all-routes-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-agilitycms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-agilitycms cms-agilitycms-app
# or
```

```bash
yarn create next-app --example cms-agilitycms cms-agilitycms-app
# or
```

```bash
pnpm create next-app --example cms-agilitycms cms-agilitycms-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-builder-io/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-builder-io cms-builder-io-app
# or
```

```bash
yarn create next-app --example cms-builder-io cms-builder-io-app
# or
```

```bash
pnpm create next-app --example cms-builder-io cms-builder-io-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-buttercms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-buttercms cms-buttercms-app
# or
```

```bash
yarn create next-app --example cms-buttercms cms-buttercms-app
# or
```

```bash
pnpm create next-app --example cms-buttercms cms-buttercms-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-contentful/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-contentful cms-contentful-app
# or
```

```bash
yarn create next-app --example cms-contentful cms-contentful-app
# or
```

```bash
pnpm create next-app --example cms-contentful cms-contentful-app
```

Expand Down
8 changes: 6 additions & 2 deletions examples/cms-cosmic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,13 @@ Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packag

```bash
npx create-next-app --example cms-cosmic cms-cosmic-app
# or
```

```bash
yarn create next-app --example cms-cosmic cms-cosmic-app
# or
```

```bash
pnpm create next-app --example cms-cosmic cms-cosmic-app
```

Expand Down

0 comments on commit c3e5caf

Please sign in to comment.