Skip to content

Commit 1cb83c1

Browse files
authored
update create-next-app documentation (vercel#25079)
Update `create-next-app` documentation based in vercel#25010 issue. ## Documentation / Examples - [X] Make sure the linting passes
1 parent 7b0fe0d commit 1cb83c1

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/api-reference/create-next-app.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ yarn create next-app
1818

1919
- **-e, --example [name]|[github-url]** - An example to bootstrap the app with. You can use an example name from the [Next.js repo](https://github.com/vercel/next.js/tree/master/examples) or a GitHub URL. The URL can use any branch and/or subdirectory.
2020
- **--example-path [path-to-example]** - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: `--example-path foo/bar`
21-
- **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. Yarn will be used by default if it's installed
21+
- **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run `yarn create next-app`
2222

2323
### Why use Create Next App?
2424

packages/create-next-app/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ npx create-next-app blog-app
1919
- **--ts, --typescript** - Initialize as a TypeScript project.
2020
- **-e, --example [name]|[github-url]** - An example to bootstrap the app with. You can use an example name from the [Next.js repo](https://github.com/vercel/next.js/tree/master/examples) or a GitHub URL. The URL can use any branch and/or subdirectory.
2121
- **--example-path <path-to-example>** - In a rare case, your GitHub URL might contain a branch name with a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar). In this case, you must specify the path to the example separately: `--example-path foo/bar`
22-
- **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. Yarn will be used by default if it's installed
22+
- **--use-npm** - Explicitly tell the CLI to bootstrap the app using npm. To bootstrap using yarn we recommend to run `yarn create next-app`
2323

2424
## Why use Create Next App?
2525

0 commit comments

Comments
 (0)