Skip to content

Clarify Mint Format Instructions #7234

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 3 commits into from
Sep 11, 2026
Merged

Clarify Mint Format Instructions #7234

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eeb5b77
Updated mintlify pages
mintlify[bot] Sep 3, 2026
e568672
Updated mintlify pages
mintlify[bot] Sep 3, 2026
74949d6
move up warning, use tip
ethanpalm Sep 11, 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
17 changes: 13 additions & 4 deletions cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@
title: "Mintlify CLI command reference"
sidebarTitle: "Commands"
description: "Complete reference for Mintlify CLI commands and flags, including mint index, mint dev, mint validate, mint broken-links, and more."
keywords: ["CLI", "mint", "commands", "flags", "reference"]
keywords:
- "CLI"
- "mint"
- "commands"
- "flags"
- "reference"
boost: 3
---

Expand Down Expand Up @@ -633,6 +638,10 @@ The overall score uses weighted scoring, so higher-impact checks contribute more

## `mint format`

<Warning>
`mint format` rewrites files in place. Commit or stash your changes before running it so you can review the diff.
</Warning>

Format every `.mdx` file in the current directory to Mintlify's canonical style. The command parses each file with the same MDX parser the web editor uses, then rewrites it in place if the canonical output differs.

```bash
Expand All @@ -641,9 +650,9 @@ mint format

Run the command from the root of your docs project. It walks every subdirectory, skipping paths matched by `.gitignore` and any Mintlify ignore rules. Files that already match the canonical output are left untouched.

<Warning>
`mint format` rewrites files in place. Commit or stash your changes before running it so you can review the diff.
</Warning>
<Tip>
Running `mint format` can result in many changes depending on the size of your project. To avoid merge conflicts and introducing changes to other in progress work, first resolve all important pending branches. Then create a new branch for formatting changes and run `mint format` on that branch.
</Tip>

When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting.

Expand Down