Skip to content

Commit

Permalink
Docs: Polish CLI pages (#69362)
Browse files Browse the repository at this point in the history
Applying feedback from Amy's review since the PR was merged:
#68899

---------

Co-authored-by: Rich Haines <hello@richardhaines.dev>
  • Loading branch information
delbaoliveira and molebox committed Aug 27, 2024
1 parent 1a52d9e commit bca90db
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions docs/02-app/02-api-reference/06-cli/create-next-app.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Create Next.js apps using one command with the create-next-app CLI.

{/* The content of this doc is shared between the app and pages router. You can use the `<PagesOnly>Content</PagesOnly>` component to add content that is specific to the Pages Router. Any shared content should not be wrapped in a component. */}

The `create-next-app` CLI allow you to quickly create a new Next.js application using the default template or an [example](https://github.com/vercel/next.js/tree/canary/examples) from a public Github repository. It is the easiest way to get started with Next.js.
The `create-next-app` CLI allow you to create a new Next.js application using the default template or an [example](https://github.com/vercel/next.js/tree/canary/examples) from a public Github repository. It is the easiest way to get started with Next.js.

Basic usage:

Expand Down Expand Up @@ -43,7 +43,7 @@ The following options are available:

## Examples

## With the default template
### With the default template

To create a new app using the default template, run the following command in your terminal:

Expand All @@ -66,17 +66,17 @@ Would you like to customize the import alias (`@/*` by default)? No / Yes

Once you've answered the prompts, a new project will be created with your chosen configuration.

## With an official Next.js example
### With an official Next.js example

To create a new app using an official Next.js example, use the `--example` flag with the following command:
To create a new app using an official Next.js example, use the `--example` flag. For example:

```bash filename="Terminal"
npx create-next-app@latest --example [your-project-name] [example-name]
```

You can view a list of all available examples along with setup instructions in the [Next.js repository](https://github.com/vercel/next.js/tree/canary/examples).

## With any public Github example
### With any public Github example

To create a new app using any public Github example, use the `--example` option with the Github repo's URL. For example:

Expand Down
2 changes: 1 addition & 1 deletion docs/02-app/02-api-reference/06-cli/next.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ PORT=4000 next dev
### Using HTTPS during development

For certain use cases like webhooks or authentication, it may be required to use HTTPS to have a secure environment on `localhost`. Next.js can generate a self-signed certificate with `next dev` using the `--experimental-https` flag:
For certain use cases like webhooks or authentication, you can use [HTTPS](https://developer.mozilla.org/en-US/docs/Glossary/HTTPS) to have a secure environment on `localhost`. Next.js can generate a self-signed certificate with `next dev` using the `--experimental-https` flag:

```bash filename="Terminal"
next dev --experimental-https
Expand Down

0 comments on commit bca90db

Please sign in to comment.