Skip to content
Open
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
12 changes: 10 additions & 2 deletions installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
alt="Decorative graphic representing the CLI."
/>

Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems.

Check warning on line 18 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L18

Use 'capability' or 'feature' instead of 'functionality'.

The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.

## Prerequisites

- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Use parentheses judiciously.

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Spell out 'LTS', if it's unfamiliar to the audience.
- [Git](https://git-scm.com/downloads) installed
- Your documentation repository cloned locally

Expand Down Expand Up @@ -181,12 +181,20 @@
mint broken-links
```

The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.

Check warning on line 184 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L184

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

To also check anchor links like `/path/to/page#anchor`, use the `--check-anchors` flag:
#### Flags

| Flag | Description |
| --- | --- |
| `--check-anchors` | Validate anchor links (e.g. `#section`) against heading slugs |

Check warning on line 190 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L190

Use parentheses judiciously.
| `--check-external` | Check external links for broken URLs |
| `--check-snippets` | Check links inside `<Snippet>` components |

Example with multiple flags:

```bash
mint broken-links --check-anchors
mint broken-links --check-anchors --check-external
```

### Find accessibility issues
Expand Down Expand Up @@ -217,7 +225,7 @@

Use flags to configure the validation command.

- `--groups [groupname]`: Mock user groups for validation (useful when testing group-based access control)

Check warning on line 228 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L228

Use parentheses judiciously.
- `--disable-openapi`: Disable OpenAPI file generation during validation

### Check OpenAPI spec
Expand All @@ -228,7 +236,7 @@
mint openapi-check <OpenAPI filename or URL>
```

Pass a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).

Check warning on line 239 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L239

Use parentheses judiciously.

### Rename files

Expand Down Expand Up @@ -300,7 +308,7 @@
```
</Accordion>
<Accordion title="Client version shows 'none' after installation">
If you run `mint version` and the client version displays as `none`, the CLI may be unable to download the client application due to a corporate firewall or VPN blocking the download.

Check warning on line 311 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L311

Spell out 'VPN', if it's unfamiliar to the audience.

**Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI.
</Accordion>
Expand Down