Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,19 @@
Port 3000 is already in use. Trying 3001 instead.
```

### Search in local preview

By default, search is disabled during local preview. To enable search, log in to

Check warning on line 114 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L114

In general, use active voice instead of passive voice ('is disabled').
the CLI first:

```bash
mint login
mint dev
```

When you are logged in, the local preview connects to your project's search index,

Check warning on line 122 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L122

In general, use active voice instead of passive voice ('are logged').
so you can test search behavior as you write.

## Skip OpenAPI processing

If you have many OpenAPI files, skip OpenAPI file processing during local development to improve performance by using the `--disable-openapi` flag:
Expand Down Expand Up @@ -177,6 +190,39 @@
```
</CodeGroup>

## Authentication

Log in to your Mintlify account from the CLI to enable features that require
a connection to your project, such as [search in local preview](#search-in-local-preview).

### Log in

Authenticate with your Mintlify account:

```bash
mint login
```

A browser window opens for you to complete the authentication flow. After you log in,
your credentials are stored locally so you stay authenticated across sessions.

Check warning on line 207 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L207

In general, use active voice instead of passive voice ('are stored').

### Check authentication status

View your current authentication status, including the email and organization associated
with your account:

```bash
mint status
```

### Log out

Remove your stored credentials:

```bash
mint logout
```

## Additional commands

### Find broken links
Expand Down
Loading