Skip to content
Open
Show file tree
Hide file tree
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
26 changes: 25 additions & 1 deletion cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@

| Client | Global configuration | Project configuration |
| --- | --- | --- |
| Claude Code | `~/.claude.json` | `.mcp.json` |

Check warning on line 96 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L96

Use 'Claude' instead of 'claude'.
| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
| VS Code | User `mcp.json` | `.vscode/mcp.json` |

Check warning on line 98 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L98

Use 'VSCode' instead of 'vscode'.
| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Global only |
Expand Down Expand Up @@ -204,7 +204,7 @@

Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details.

If the command fails with `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`, the domain is bound to another Mintlify deployment. See [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization) to release it and re-add it.

Check warning on line 207 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L207

In general, use active voice instead of passive voice ('is bound').

<Note>
If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard for the remaining values.
Expand Down Expand Up @@ -351,7 +351,7 @@

### `mint analytics stats`

Display top-line KPIs for a date range: views, visitors, searches, feedback, and assistant usage. The output reports human and agent traffic separately.

Check warning on line 354 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L354

Did you really mean 'KPIs'?

```bash
mint analytics stats [flags]
Expand Down Expand Up @@ -500,7 +500,7 @@
| `--check-redirects` | Also check that redirect destinations in `docs.json` resolve to valid paths. |
| `--check-snippets` | Also check links inside `<Snippet>` components. |

Pass `--files` to limit the check to specific pages. This is useful for validating a single page you just edited or scoping checks to a directory in CI. When `--files` is set with `--check-external`, only external URLs on the selected pages are fetched.

Check warning on line 503 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L503

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

```bash
# Check a specific page
Expand Down Expand Up @@ -631,6 +631,31 @@

---

## `mint test`

Test the code examples in your documentation with a local coding agent. Requires authentication with `mint login`.

```bash
mint test
```

Run the command from your docs directory. It scans your pages for fenced code blocks and checks which pages contain testable examples. A coding agent generates tests for each page. The command runs the generated tests and reports which pages pass or fail.

`mint test` runs coding agents through their SDKs, which you install separately:

| Agent | Installation |
| --- | --- |
| Claude (default) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` |
| Codex | `npm install @openai/codex-sdk` |

In interactive terminals, the command opens a guided interface where you select a coding agent and the pages to test. You can watch live progress and review results, including previews of the generated test files. You can resume an interrupted run, and past runs are saved so you can revisit their reports.

Check warning on line 651 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L651

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

In non-interactive environments, such as CI, the command runs Claude against automatically selected pages and prints a summary of passed and failed pages. It exits with code `0` if every test passes or `1` otherwise.

Generated test files are written to `tests/mint-test/` inside your docs directory. Run reports are saved to `.mintlify/test/`.

Check warning on line 655 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L655

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

Check warning on line 655 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L655

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

---

## `mint format`

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.
Expand All @@ -639,13 +664,13 @@
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.

Check warning on line 667 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L667

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

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

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.

Check warning on line 673 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L673

In general, use active voice instead of passive voice ('were reformatted').

---

Expand Down Expand Up @@ -693,14 +718,13 @@
| Command | Description |
| --- | --- |
| `mint ai` | AI-powered documentation tools. |
| `mint test` | Documentation testing. |
| `mint mcp` | MCP server for documentation. |

---

## Telemetry

The CLI collects anonymous usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. Mintlify does **not** collect personally identifiable information, project content, or file paths.

Check warning on line 727 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L727

Did you really mean 'informat'?

By default, the CLI collects telemetry data. You can opt out at any time using the `--telemetry` flag:

Expand Down
2 changes: 1 addition & 1 deletion editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<img src="/images/editor/comment-dark.png" alt="The comment button in the floating toolbar above selected text in the editor." className="hidden dark:block" />
</Frame>

React to a comment to acknowledge it without replying. Hover over a comment, click the **Add reaction** button, and choose an emoji. Search the picker to find a specific emoji. Click an existing reaction to add or remove yours. Hover over a reaction to see who reacted. Reacting to someone else's comment notifies the comment's author.

Check warning on line 23 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L23

Did you really mean 'else's'?

All [roles](/dashboard/roles) can comment and reply, including viewers. Only editors and admins can resolve threads. Resolving a thread removes it from the sidebar and clears the highlight from the page.

Expand Down Expand Up @@ -59,7 +59,7 @@

## Real-time editing

When multiple people open the same page on the same branch, they edit together. Each person's cursor and edits are visible to everyone, with avatars in the toolbar.
When multiple people open the same page on the same branch, they edit together, in both visual and source mode. Each person's cursor and edits are visible to everyone, with avatars in the toolbar.

- Changes from all collaborators merge automatically. Two people editing the same section won't create conflicts.
- Undo only affects your own edits.
Expand Down
2 changes: 1 addition & 1 deletion editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

## Home and Publishing

The editor workspace is split into two tabs: **Home** and **Publishing**.

Check warning on line 10 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L10

In general, use active voice instead of passive voice ('is split').

**Home** is your workspace. It shows the content files in your repository, including your private pages, whether or not they appear on your published site.

**Publishing** is your published site. It shows the navigation your visitors see, along with your site settings.

{/* vale Mintlify.OxfordComma = NO */}
Home hides some files by default, including `docs.json`, files and folders whose names start with a dot, files with no extension, all-caps Markdown files like `README.md`, and `.css`, `.js`, `.jsx`, `.mjs`, `.cjs`, and `.pdf` files. To see all files, turn on [Show all files](/editor/settings) or press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows).
Home lists only Markdown pages (`.md` and `.mdx` files) by default. It hides every other file type, such as images, code, spec and data files, PDFs, and `docs.json`, along with dotfiles and all-caps Markdown files like `README.md`. To see all files, turn on [Show all files](/editor/settings) or press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows).
{/* vale Mintlify.OxfordComma = YES */}

## Create a page
Expand Down Expand Up @@ -60,7 +60,7 @@

To view version history, click <Icon icon="ellipsis" /> **More options** in the top-right of the page, then click **Version history**.

If you restore a version, it overwrites any unsaved changes you made to the page. When you restore a public page, it is only restored on your current branch. When you restore a private page, it is restored on all branches.

Check warning on line 63 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L63

In general, use active voice instead of passive voice ('is restored').

## Private pages

Expand Down
2 changes: 1 addition & 1 deletion editor/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
- **Fit editor to full width**: Stretch the editing canvas edge-to-edge instead of the default 768px column.
- **Show breadcrumbs**: Show the page's location in the site navigation above the editing canvas.
- **Open live preview in new tab**: Open the rendered page in a new browser tab when you preview, instead of the split-pane preview.
- **Show all files**: Show every file in the sidebar, including dotfiles, code, PDFs, and other files hidden by default. You can also press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows) to toggle.
- **Show all files**: The sidebar lists only Markdown pages by default. Turn this on to also show images, spec and data files, code, PDFs, and dotfiles. You can also press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows) to toggle.

## PR instructions

Expand All @@ -40,7 +40,7 @@
using its relative path.
```

Instructions are limited to 20,000 characters.

Check warning on line 43 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L43

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

## Main branch autocommits

Expand Down Expand Up @@ -73,7 +73,7 @@
- **Edit with AI** actions on a selection, such as rewrite, expand, or fix.
- **Agent sessions** started from the editor.

Each teammate maintains their own instructions, scoped to their user account. Instructions are limited to 20,000 characters.

Check warning on line 76 in editor/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/settings.mdx#L76

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

Add AI instructions when you find yourself repeating the same guidance in prompts, for example:

Expand Down
28 changes: 27 additions & 1 deletion es/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -705,6 +705,33 @@ La puntuación general utiliza puntuación ponderada, por lo que las verificacio

---

<div id="mint-test">
## `mint test`
</div>

Prueba los ejemplos de código de tu documentación con un agente de codificación local. Requiere autenticación con `mint login`.

```bash
mint test
```

Ejecuta el comando desde tu directorio de documentación. Analiza tus páginas en busca de bloques de código delimitados y verifica qué páginas contienen ejemplos que se pueden probar. Un agente de codificación genera pruebas para cada página. El comando ejecuta las pruebas generadas e informa qué páginas pasan o fallan.

`mint test` ejecuta los agentes de codificación a través de sus SDK, que se instalan por separado:

| Agente | Instalación |
| --- | --- |
| Claude (predeterminado) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` |
| Codex | `npm install @openai/codex-sdk` |

En terminales interactivas, el comando abre una interfaz guiada donde seleccionas un agente de codificación y las páginas a probar. Puedes observar el progreso en vivo y revisar los resultados, incluidas vistas previas de los archivos de prueba generados. Puedes reanudar una ejecución interrumpida, y las ejecuciones anteriores se guardan para que puedas volver a consultar sus informes.

En entornos no interactivos, como CI, el comando ejecuta Claude sobre páginas seleccionadas automáticamente e imprime un resumen de las páginas que pasaron y fallaron. Termina con el código `0` si todas las pruebas pasan o `1` en caso contrario.

Los archivos de prueba generados se escriben en `tests/mint-test/` dentro de tu directorio de documentación. Los informes de cada ejecución se guardan en `.mintlify/test/`.

---

<div id="mint-format">
## `mint format`
</div>
Expand Down Expand Up @@ -777,7 +804,6 @@ Estos comandos están disponibles para ejecutar pero aún no son funcionales. Ej
| Comando | Descripción |
| --- | --- |
| `mint ai` | Herramientas de documentación con IA. |
| `mint test` | Pruebas de documentación. |
| `mint mcp` | Servidor MCP para documentación. |

---
Expand Down
2 changes: 1 addition & 1 deletion es/editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Las menciones funcionan en páginas privadas para los miembros que ya tienen acc

</div>

Cuando varias personas abren la misma página en la misma branch, editan conjuntamente. El cursor y las ediciones de cada persona son visibles para todos, con avatares en la barra de herramientas.
Cuando varias personas abren la misma página en la misma branch, editan conjuntamente, tanto en modo visual como en modo fuente. El cursor y las ediciones de cada persona son visibles para todos, con avatares en la barra de herramientas.

- Los cambios de todos los colaboradores se combinan automáticamente. Que dos personas editen la misma sección no genera conflictos.
- Deshacer solo afecta a sus propias ediciones.
Expand Down
2 changes: 1 addition & 1 deletion es/editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ El espacio de trabajo del editor se divide en dos pestañas: **Home** y **Publis

**Publishing** es su sitio publicado. Muestra la navegación que ven sus visitantes, junto con la configuración de su sitio.

Home oculta algunos archivos de forma predeterminada, entre ellos `docs.json`, los archivos y carpetas cuyo nombre empieza por un punto, los archivos sin extensión, los archivos Markdown en mayúsculas como `README.md` y los archivos `.css`, `.js`, `.jsx`, `.mjs`, `.cjs` y `.pdf`. Para ver todos los archivos, active [Show all files](/es/editor/settings#appearance) o presione <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) o <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows).
Home muestra de forma predeterminada solo las páginas Markdown (archivos `.md` y `.mdx`). Oculta todos los demás tipos de archivo, como imágenes, código, archivos de especificación y de datos, PDF y `docs.json`, además de los dotfiles y los archivos Markdown en mayúsculas como `README.md`. Para ver todos los archivos, active [Show all files](/es/editor/settings#appearance) o presione <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) o <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows).

<div id="create-a-page">

Expand Down
2 changes: 1 addition & 1 deletion es/editor/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Los ajustes de apariencia son preferencias personales. Cambian el editor solo pa
- **Fit editor to full width**: Extiende el lienzo de edición de borde a borde en lugar de usar la columna predeterminada de 768px.
- **Show breadcrumbs**: Muestra la ubicación de la página en la navegación del sitio encima del lienzo de edición.
- **Open live preview in new tab**: Abre la página representada en una pestaña nueva del navegador al previsualizar, en lugar de la vista previa en panel dividido.
- **Show all files**: Muestra todos los archivos en la barra lateral, incluidos los dotfiles, el código, los PDF y otros archivos ocultos de forma predeterminada. También puede pulsar <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) o <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows) para alternarlo.
- **Show all files**: La barra lateral muestra solo las páginas Markdown de forma predeterminada. Active esta opción para mostrar también imágenes, archivos de especificación y de datos, código, PDF y dotfiles. También puede pulsar <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) o <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows) para alternarlo.

<div id="pr-instructions">

Expand Down
28 changes: 27 additions & 1 deletion fr/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -707,6 +707,33 @@ Le score global utilise une notation pondérée, de sorte que les vérifications

---

<div id="mint-test">
## `mint test`
</div>

Testez les exemples de code de votre documentation avec un agent de codage local. Nécessite une authentification avec `mint login`.

```bash
mint test
```

Exécutez la commande depuis votre répertoire de documentation. Elle analyse vos pages à la recherche de blocs de code délimités et vérifie quelles pages contiennent des exemples testables. Un agent de codage génère des tests pour chaque page. La commande exécute les tests générés et indique quelles pages réussissent ou échouent.

`mint test` exécute les agents de codage via leurs SDK, que vous installez séparément :

| Agent | Installation |
| --- | --- |
| Claude (par défaut) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` |
| Codex | `npm install @openai/codex-sdk` |

Dans les terminaux interactifs, la commande ouvre une interface guidée où vous sélectionnez un agent de codage et les pages à tester. Vous pouvez suivre la progression en direct et examiner les résultats, y compris des aperçus des fichiers de test générés. Vous pouvez reprendre une exécution interrompue, et les exécutions passées sont enregistrées pour que vous puissiez consulter à nouveau leurs rapports.

Dans les environnements non interactifs, comme la CI, la commande exécute Claude sur des pages sélectionnées automatiquement et affiche un résumé des pages réussies et échouées. Elle se termine avec le code `0` si tous les tests réussissent ou `1` sinon.

Les fichiers de test générés sont écrits dans `tests/mint-test/` à l'intérieur de votre répertoire de documentation. Les rapports d'exécution sont enregistrés dans `.mintlify/test/`.

---

<div id="mint-format">
## `mint format`
</div>
Expand Down Expand Up @@ -779,7 +806,6 @@ Ces commandes sont disponibles mais ne sont pas encore fonctionnelles. Les exéc
| Commande | Description |
| --- | --- |
| `mint ai` | Outils de documentation assistés par IA. |
| `mint test` | Tests de documentation. |
| `mint mcp` | Serveur MCP pour la documentation. |

---
Expand Down
2 changes: 1 addition & 1 deletion fr/editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Les mentions fonctionnent sur les pages privées pour les membres qui y ont déj

</div>

Lorsque plusieurs personnes ouvrent la même page sur la même branch, elles la modifient ensemble. Le curseur et les modifications de chacun sont visibles par tous, avec des avatars dans la barre d'outils.
Lorsque plusieurs personnes ouvrent la même page sur la même branch, elles la modifient ensemble, en mode visuel comme en mode source. Le curseur et les modifications de chacun sont visibles par tous, avec des avatars dans la barre d'outils.

- Les modifications de tous les collaborateurs fusionnent automatiquement. Deux personnes qui modifient la même section ne créent pas de conflit.
- L'annulation n'affecte que vos propres modifications.
Expand Down
2 changes: 1 addition & 1 deletion fr/editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ L'espace de travail de l'éditeur est divisé en deux onglets : **Home** et **Pu

**Publishing** est votre site publié. Il affiche la navigation que voient vos visiteurs, ainsi que les paramètres de votre site.

Home masque certains fichiers par défaut, notamment `docs.json`, les fichiers et dossiers dont le nom commence par un point, les fichiers sans extension, les fichiers Markdown en majuscules comme `README.md`, ainsi que les fichiers `.css`, `.js`, `.jsx`, `.mjs`, `.cjs` et `.pdf`. Pour afficher tous les fichiers, activez [Show all files](/fr/editor/settings#appearance) ou appuyez sur <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) ou <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows).
Home n'affiche par défaut que les pages Markdown (fichiers `.md` et `.mdx`). Il masque tous les autres types de fichiers, comme les images, le code, les fichiers de spécification et de données, les PDF et `docs.json`, ainsi que les dotfiles et les fichiers Markdown en majuscules comme `README.md`. Pour afficher tous les fichiers, activez [Show all files](/fr/editor/settings#appearance) ou appuyez sur <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) ou <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows).

<div id="create-a-page">

Expand Down
2 changes: 1 addition & 1 deletion fr/editor/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Les paramètres d'apparence sont des préférences personnelles. Ils ne modifien
- **Fit editor to full width** : Étend la zone d'édition d'un bord à l'autre au lieu de la colonne de 768px par défaut.
- **Show breadcrumbs** : Affiche l'emplacement de la page dans la navigation du site au-dessus de la zone d'édition.
- **Open live preview in new tab** : Ouvre la page rendue dans un nouvel onglet du navigateur lors de la prévisualisation, au lieu de l'aperçu en volet partagé.
- **Show all files** : Affiche tous les fichiers dans la barre latérale, y compris les dotfiles, le code, les PDF et les autres fichiers masqués par défaut. Vous pouvez aussi appuyer sur <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) ou <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows) pour basculer l'affichage.
- **Show all files** : La barre latérale n'affiche par défaut que les pages Markdown. Activez cette option pour afficher aussi les images, les fichiers de spécification et de données, le code, les PDF et les dotfiles. Vous pouvez aussi appuyer sur <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) ou <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows) pour basculer l'affichage.

<div id="pr-instructions">

Expand Down
30 changes: 28 additions & 2 deletions zh/cli/commands.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Mintlify CLI 命令参考"
sidebarTitle: "命令参考"
description: "Mintlify CLI 所有命令和选项的完整参考,涵盖 mint index、mint dev、mint validatemint broken-links,并说明客户端选择、项目配置、MCP 规则及更多 CLI 工作流,帮助你完成日常文档开发以及部署前检查。"
description: "Mintlify CLI 命令与选项的完整参考,涵盖 mint dev、mint validatemint broken-links 等命令的用法。"
keywords: ["CLI", "mint", "命令", "选项", "参考"]
boost: 3
---
Expand Down Expand Up @@ -707,6 +707,33 @@ mint score docs.example.com

---

<div id="mint-test">
## `mint test`
</div>

使用本地编码代理测试文档中的代码示例。需要先通过 `mint login` 进行身份验证。

```bash
mint test
```

在文档目录中运行该命令。它会扫描页面中的围栏代码块,并检查哪些页面包含可测试的示例。编码代理为每个页面生成测试。该命令运行生成的测试,并报告哪些页面通过或失败。

`mint test` 通过编码代理的 SDK 运行代理,这些 SDK 需要单独安装:

| 代理 | 安装方式 |
| --- | --- |
| Claude(默认) | `npm install @anthropic-ai/claude-agent-sdk @anthropic-ai/sdk @modelcontextprotocol/sdk` |
| Codex | `npm install @openai/codex-sdk` |

在交互式终端中,该命令会打开一个引导式界面,你可以在其中选择编码代理和要测试的页面。你可以实时查看进度并审查结果,包括预览生成的测试文件。你可以恢复被中断的运行;历史运行也会被保存,方便你随时回看报告。

在非交互式环境(例如 CI)中,该命令使用 Claude 对自动选择的页面运行测试,并打印通过和失败页面的摘要。所有测试通过时以退出码 `0` 结束,否则以 `1` 结束。

生成的测试文件写入文档目录下的 `tests/mint-test/`。运行报告保存在 `.mintlify/test/` 中。

---

<div id="mint-format">
## `mint format`
</div>
Expand Down Expand Up @@ -779,7 +806,6 @@ mint version
| 命令 | 描述 |
| --- | --- |
| `mint ai` | AI 驱动的文档工具。 |
| `mint test` | 文档测试。 |
| `mint mcp` | 文档 MCP 服务器。 |

---
Expand Down
2 changes: 1 addition & 1 deletion zh/editor/collaborate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Editors 和 admins 可以接受或拒绝任何建议,viewers 不能。

</div>

当多人在同一分支上打开同一页面时,他们会协同编辑。每个人的光标和编辑对所有人可见,工具栏中会显示头像。
当多人在同一分支上打开同一页面时,他们会协同编辑,可视化模式和源码模式均支持。每个人的光标和编辑对所有人可见,工具栏中会显示头像。

- 所有协作者的更改会自动合并。两人编辑同一部分不会产生冲突。
- 撤销只影响你自己的编辑。
Expand Down
2 changes: 1 addition & 1 deletion zh/editor/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ keywords: ["editor", "content", "pages", "navigation", "version history", "media

**Publishing** 是你已发布的站点,显示访问者看到的导航以及站点设置。

Home 默认会隐藏部分文件,包括 `docs.json`、名称以点开头的文件和文件夹、没有扩展名的文件、像 `README.md` 这样的全大写 Markdown 文件,以及 `.css`、`.js`、`.jsx`、`.mjs`、`.cjs` 和 `.pdf` 文件。若要查看全部文件,请启用 [Show all files](/zh/editor/settings#appearance),或按 <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd>(macOS)或 <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd>(Windows)。
Home 默认只显示 Markdown 页面(`.md` 和 `.mdx` 文件)。其他所有文件类型都会被隐藏,例如图片、代码、规范和数据文件、PDF 以及 `docs.json`,还有 dotfile 和像 `README.md` 这样的全大写 Markdown 文件。若要查看全部文件,请启用 [Show all files](/zh/editor/settings#appearance),或按 <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd>(macOS)或 <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd>(Windows)。

<div id="create-a-page">

Expand Down
Loading