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
1 change: 1 addition & 0 deletions cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
| `--no-open` | Do not open the browser automatically. |
| `--groups` | Comma-separated list of user groups to mock for preview. |
| `--disable-openapi` | Skip OpenAPI file processing to improve performance. |
| `--disable-prefetch` | Disable navigation prefetching in the local preview. |

Check warning on line 33 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L33

Did you really mean 'prefetching'?
| `--local-schema` | Allow locally hosted OpenAPI files served over HTTP. |

---
Expand Down Expand Up @@ -283,7 +284,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 287 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L287

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

```bash
# Check a specific page
Expand Down Expand Up @@ -463,13 +464,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 467 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L467

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 473 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L473

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

---

Expand Down
8 changes: 8 additions & 0 deletions cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@
mint dev --disable-openapi
```

## Disable navigation prefetching

Check warning on line 76 in cli/preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/preview.mdx#L76

Did you really mean 'prefetching'?

The local preview prefetches pages linked from the current page to make in-app navigation feel instant. If you notice high memory or CPU usage on very large sites, disable prefetching with the `--disable-prefetch` flag:

Check warning on line 78 in cli/preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/preview.mdx#L78

Did you really mean 'prefetches'?

Check warning on line 78 in cli/preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/preview.mdx#L78

Did you really mean 'prefetching'?

```bash
mint dev --disable-prefetch
```

## Preview as a specific group

If you use group-based access control, preview as a specific authentication group with the `--groups` flag:
Expand Down
1 change: 1 addition & 0 deletions es/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ mint dev [flags]
| `--no-open` | No abrir el navegador automáticamente. |
| `--groups` | Lista separada por comas de grupos de usuarios a simular para la previsualización. |
| `--disable-openapi` | Omitir el procesamiento de archivos OpenAPI para mejorar el rendimiento. |
| `--disable-prefetch` | Desactivar el prefetching de navegación en la vista previa local. |
| `--local-schema` | Permitir archivos OpenAPI alojados localmente servidos por HTTP. |

---
Expand Down
10 changes: 10 additions & 0 deletions es/cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ Si tienes muchos archivos OpenAPI, omite el procesamiento de OpenAPI durante el
mint dev --disable-openapi
```

<div id="disable-navigation-prefetching">
## Desactivar el prefetching de navegación
</div>

La vista previa local hace prefetch de las páginas enlazadas desde la página actual para que la navegación dentro de la app se sienta instantánea. Si notas un uso alto de memoria o CPU en sitios muy grandes, desactiva el prefetching con el flag `--disable-prefetch`:

```bash
mint dev --disable-prefetch
```

<div id="preview-as-a-specific-group">
## Previsualizar como un grupo específico
</div>
Expand Down
1 change: 1 addition & 0 deletions fr/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ mint dev [flags]
| `--no-open` | Ne pas ouvrir le navigateur automatiquement. |
| `--groups` | Liste séparée par des virgules de groupes d'utilisateurs à simuler pour la prévisualisation. |
| `--disable-openapi` | Ignorer le traitement des fichiers OpenAPI pour améliorer les performances. |
| `--disable-prefetch` | Désactive le prefetching de navigation dans l'aperçu local. |
| `--local-schema` | Autoriser les fichiers OpenAPI hébergés localement servis via HTTP. |

---
Expand Down
10 changes: 10 additions & 0 deletions fr/cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ Si vous avez de nombreux fichiers OpenAPI, ignorez le traitement OpenAPI pendant
mint dev --disable-openapi
```

<div id="disable-navigation-prefetching">
## Désactiver le prefetching de navigation
</div>

L'aperçu local précharge les pages liées depuis la page actuelle pour rendre la navigation instantanée. Si vous constatez une utilisation élevée de la mémoire ou du CPU sur de très grands sites, désactivez le prefetching avec le flag `--disable-prefetch` :

```bash
mint dev --disable-prefetch
```

<div id="preview-as-a-specific-group">
## Prévisualiser en tant que groupe spécifique
</div>
Expand Down
1 change: 1 addition & 0 deletions zh/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ mint dev [flags]
| `--no-open` | 不自动打开浏览器。 |
| `--groups` | 以逗号分隔的用户组列表,用于模拟预览。 |
| `--disable-openapi` | 跳过 OpenAPI 文件处理以提高性能。 |
| `--disable-prefetch` | 在本地预览中禁用导航预取。 |
| `--local-schema` | 允许通过 HTTP 提供的本地托管 OpenAPI 文件。 |

---
Expand Down
10 changes: 10 additions & 0 deletions zh/cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ mint dev --port 3333
mint dev --disable-openapi
```

<div id="disable-navigation-prefetching">
## 禁用导航预取
</div>

本地预览会预取当前页面链接到的页面,使应用内导航感觉即时。如果你在超大站点上遇到内存或 CPU 占用过高的问题,可以使用 `--disable-prefetch` 标志禁用预取:

```bash
mint dev --disable-prefetch
```

<div id="preview-as-a-specific-group">
## 以特定组预览
</div>
Expand Down