Skip to content

Document mint validate CLI command #2736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 4 commits into from
Jan 17, 2026
Merged

Document mint validate CLI command #2736

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
33e7086
Update installation.mdx
hahnbeelee Jan 16, 2026
373931c
copyedit for concision
ethanpalm Jan 16, 2026
164c878
vale
ethanpalm Jan 17, 2026
3156ac6
remove brief example
ethanpalm Jan 17, 2026
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
13 changes: 13 additions & 0 deletions installation.mdx
View file
Open in desktop
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 

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 @@ -178,7 +178,7 @@
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 181 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L181 

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

### Find accessibility issues

Expand All @@ -198,6 +198,19 @@
mint a11y --skip-alt-text
```

### Validate documentation build

Validate your documentation build in strict mode, which exits with an error if there are any warnings or errors. Use this command for CI/CD pipelines to prevent broken documentation deployments.
Copy link
Contributor

@tembo tembo bot Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider calling out the non-zero exit code explicitly (makes the CI behavior clearer).

Suggested change
Validate your documentation build in strict mode, which exits with an error if there are any warnings or errors. Use this command for CI/CD pipelines to prevent broken documentation deployments.
Validate your documentation build in strict mode. The command exits with a non-zero status code if it finds any warnings or errors, which makes it useful in CI/CD pipelines to prevent broken documentation deployments.


```bash
mint validate
```

Use flags to configure the validation command.

- `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication)
Copy link
Contributor

@tembo tembo bot Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit: using <groupname> matches the placeholder style used elsewhere on this page (and adding a period keeps the list consistent).

Suggested change
- `--groups [groupname]`: Mock user groups for validation (useful when testing partial authentication)
- `--groups <groupname>`: Simulate user groups during validation (useful when testing partial authentication).

- `--disable-openapi`: Disable OpenAPI file generation during validation
Copy link
Contributor

@tembo tembo bot Jan 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `--disable-openapi`: Disable OpenAPI file generation during validation
- `--disable-openapi`: Disable OpenAPI file generation during validation.


### Check OpenAPI spec

Check your OpenAPI file for errors with the following command:
Expand Down Expand Up @@ -228,7 +241,7 @@

## Formatting

While developing locally, we recommend using extensions in your IDE to recognize and format MDX files.

Check warning on line 244 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L244 

Use 'ide' instead of 'IDE'.

If you use Cursor, Windsurf, or VS Code, we recommend the [MDX VS Code extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.

Expand Down Expand Up @@ -278,7 +291,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 294 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L294 

Use 'app' instead of 'application'.

Check warning on line 294 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L294 

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