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. Useful for very large sites where background prefetching slows down page loads. |

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'?

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
12 changes: 12 additions & 0 deletions cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,18 @@
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'?

By default, the local preview prefetches nearby pages so that navigating between them feels instant. For very large sites, this can slow down the page you are actively viewing because many pages compile in the background at the same time.

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'?

If you have thousands of pages and notice slow page loads during local preview, disable prefetching with the `--disable-prefetch` flag:

Check warning on line 80 in cli/preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/preview.mdx#L80

Did you really mean 'prefetching'?

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

With prefetching disabled, pages compile only when you navigate to them. Individual page loads take longer than a prefetched page, but the page you request is not competing with background compilation.

Check warning on line 86 in cli/preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/preview.mdx#L86

Did you really mean 'prefetching'?

Check warning on line 86 in cli/preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/preview.mdx#L86

Did you really mean 'prefetched'?

## 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` | Deshabilitar la precarga de navegación en la vista previa local. Útil para sitios muy grandes donde la precarga en segundo plano ralentiza la carga de páginas. |
| `--local-schema` | Permitir archivos OpenAPI alojados localmente servidos por HTTP. |

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

<div id="disable-navigation-prefetching">
## Deshabilitar la precarga de navegación
</div>

De forma predeterminada, la vista previa local precarga las páginas cercanas para que la navegación entre ellas se sienta instantánea. En sitios muy grandes, esto puede ralentizar la página que estás viendo, porque muchas páginas se compilan en segundo plano al mismo tiempo.

Si tienes miles de páginas y notas cargas de página lentas durante la vista previa local, deshabilita la precarga con el flag `--disable-prefetch`:

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

Con la precarga deshabilitada, las páginas se compilan solo cuando navegas a ellas. Las cargas de página individuales tardan más que una página precargada, pero la página que solicitas no compite con la compilación en segundo plano.

<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ésactiver le préchargement de la navigation dans la prévisualisation locale. Utile pour les très grands sites où le préchargement en arrière-plan ralentit le chargement des pages. |
| `--local-schema` | Autoriser les fichiers OpenAPI hébergés localement servis via HTTP. |

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

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

Par défaut, la prévisualisation locale précharge les pages voisines pour que la navigation entre elles semble instantanée. Sur les très grands sites, cela peut ralentir la page que vous consultez, car de nombreuses pages sont compilées en arrière-plan en même temps.

Si vous avez des milliers de pages et constatez des chargements de page lents lors de la prévisualisation locale, désactivez le préchargement avec le flag `--disable-prefetch` :

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

Avec le préchargement désactivé, les pages ne sont compilées que lorsque vous y accédez. Les chargements de page individuels prennent plus de temps qu'une page préchargée, mais la page que vous demandez n'est pas en concurrence avec la compilation en arrière-plan.

<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
14 changes: 14 additions & 0 deletions zh/cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,20 @@ mint dev --port 3333
mint dev --disable-openapi
```

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

默认情况下,本地预览会预加载附近的页面,让页面之间的导航感觉是瞬时的。对于非常大的站点,这可能会拖慢你当前正在查看的页面,因为许多页面同时在后台编译。

如果你有数千个页面,并且注意到本地预览时页面加载缓慢,可以使用 `--disable-prefetch` 选项禁用预加载:

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

禁用预加载后,页面只会在你导航到它们时才会编译。单个页面加载时间会比预加载的页面更长,但你请求的页面不会与后台编译争抢资源。

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