From 8c79ca40375e923b2011be8a167178dc944a185b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 21 Oct 2026 19:23:14 +0000 Subject: [PATCH] docs: translate mint dev docs.json generation section into es, fr, zh --- es/cli/preview.mdx | 17 +++++++++++++++-- fr/cli/preview.mdx | 17 +++++++++++++++-- zh/cli/preview.mdx | 17 +++++++++++++++-- 3 files changed, 45 insertions(+), 6 deletions(-) diff --git a/es/cli/preview.mdx b/es/cli/preview.mdx index 93efaa58cc..5773a8181a 100644 --- a/es/cli/preview.mdx +++ b/es/cli/preview.mdx @@ -9,13 +9,12 @@ keywords: ["mint dev", "previsualización local", "localhost", "mint login", "b - La [CLI de Mintlify](/es/cli/install) instalada globalmente, o ejecuta los comandos con `npx mint`. -- Un directorio de documentación con un archivo `docs.json` válido.
## Iniciar la previsualización local
-Navega al directorio de tu documentación que contiene el archivo `docs.json` y ejecuta: +Navega al directorio de tu documentación y ejecuta: ```bash mint dev @@ -35,6 +34,20 @@ Para generar una previsualización sin instalar la CLI globalmente, ejecuta: npx mint dev ``` +
+ ### Previsualizar un directorio sin un archivo `docs.json` +
+ +Si ejecutas `mint dev` en un directorio que no tiene un archivo `docs.json`, la CLI genera un archivo `docs.json` a partir de la estructura de tu directorio. La navegación generada sigue estos patrones: + +- Crea un grupo llamado **Introduction** para los archivos Markdown y MDX en la raíz del directorio. +- Crea un grupo para cada subdirectorio de nivel superior, y los subdirectorios anidados se convierten en subgrupos. +- Las páginas llamadas `index` o `readme` aparecen primero en su grupo. Las demás páginas y carpetas se ordenan alfabéticamente, o numéricamente si los títulos contienen números. +- Los nombres de los grupos usan los nombres de los subdirectorios, sin ningún prefijo numérico inicial. Por ejemplo, una carpeta llamada `01-getting-started` se convierte en un grupo llamado **Getting started**. +- La CLI omite los archivos y carpetas que empiezan por `.` o `_`, las carpetas `node_modules` y `snippets`, y las rutas de tu archivo [`.mintignore`](/es/organize/mintignore). + +El nombre del sitio proviene del campo `name` de un archivo `package.json` en el directorio o en su directorio padre. Si no hay un archivo `package.json`, la CLI usa el nombre del directorio. Edita el archivo `docs.json` generado para personalizar tu navegación, tema y colores. + Si escribes en VS Code o Cursor, la [extensión Mintlify MDX](/es/cli/mdx-extension) ejecuta esta previsualización en un panel junto a tu editor y la desplaza para coincidir con la página que estás editando. diff --git a/fr/cli/preview.mdx b/fr/cli/preview.mdx index 6796f94b19..334ef821ed 100644 --- a/fr/cli/preview.mdx +++ b/fr/cli/preview.mdx @@ -9,13 +9,12 @@ keywords: ["mint dev", "prévisualisation locale", "localhost", "mint login", "r - La [CLI Mintlify](/fr/cli/install) installée globalement, ou exécutez les commandes avec `npx mint`. -- Un répertoire de documentation contenant un fichier `docs.json` valide.
## Démarrer la prévisualisation locale
-Naviguez jusqu'au répertoire de votre documentation contenant votre fichier `docs.json` et exécutez : +Naviguez jusqu'au répertoire de votre documentation et exécutez : ```bash mint dev @@ -35,6 +34,20 @@ Pour générer une prévisualisation sans installer la CLI globalement, exécute npx mint dev ``` +
+ ### Prévisualiser un répertoire sans fichier `docs.json` +
+ +Si vous exécutez `mint dev` dans un répertoire qui ne contient pas de fichier `docs.json`, la CLI génère un fichier `docs.json` à partir de la structure de votre répertoire. La navigation générée suit ces règles : + +- Crée un groupe nommé **Introduction** pour les fichiers Markdown et MDX situés à la racine du répertoire. +- Crée un groupe pour chaque sous-répertoire de premier niveau, et les sous-répertoires imbriqués deviennent des sous-groupes. +- Les pages nommées `index` ou `readme` apparaissent en premier dans leur groupe. Les autres pages et dossiers sont triés par ordre alphabétique, ou numérique si les titres contiennent des nombres. +- Les noms de groupes reprennent les noms des sous-répertoires, sans préfixe numérique initial. Par exemple, un dossier nommé `01-getting-started` devient un groupe nommé **Getting started**. +- La CLI ignore les fichiers et dossiers commençant par `.` ou `_`, les dossiers `node_modules` et `snippets`, ainsi que les chemins listés dans votre fichier [`.mintignore`](/fr/organize/mintignore). + +Le nom du site provient du champ `name` d'un fichier `package.json` situé dans le répertoire ou dans son répertoire parent. En l'absence de fichier `package.json`, la CLI utilise le nom du répertoire. Modifiez le fichier `docs.json` généré pour personnaliser votre navigation, votre thème et vos couleurs. + Si vous rédigez dans VS Code ou Cursor, l'[extension Mintlify MDX](/fr/cli/mdx-extension) exécute cette prévisualisation dans un panneau à côté de votre éditeur et la fait défiler pour correspondre à la page que vous modifiez. diff --git a/zh/cli/preview.mdx b/zh/cli/preview.mdx index 4b4cda4176..2885a74da9 100644 --- a/zh/cli/preview.mdx +++ b/zh/cli/preview.mdx @@ -9,13 +9,12 @@ keywords: ["mint dev", "本地预览", "localhost", "mint login", "搜索", "助 - 已全局安装 [Mintlify CLI](/zh/cli/install)，或使用 `npx mint` 运行命令。 -- 包含有效 `docs.json` 文件的文档目录。
## 启动本地预览
-导航到包含 `docs.json` 文件的文档目录，然后运行： +导航到你的文档目录，然后运行： ```bash mint dev @@ -35,6 +34,20 @@ mint dev --no-open npx mint dev ``` +
+ ### 预览没有 `docs.json` 文件的目录 +
+ +如果你在没有 `docs.json` 文件的目录中运行 `mint dev`，CLI 会根据你的目录结构生成一个 `docs.json` 文件。生成的导航遵循以下规则： + +- 为目录根级的 Markdown 和 MDX 文件创建一个名为 **Introduction** 的分组。 +- 为每个顶级子目录创建一个分组，嵌套的子目录会成为子分组。 +- 名为 `index` 或 `readme` 的页面在其分组中排在最前面。其他页面和文件夹按字母顺序排序；如果标题包含数字，则按数字顺序排序。 +- 分组名称使用子目录名称，并去掉开头的数字前缀。例如，名为 `01-getting-started` 的文件夹会成为名为 **Getting started** 的分组。 +- CLI 会跳过以 `.` 或 `_` 开头的文件和文件夹、`node_modules` 和 `snippets` 文件夹，以及 [`.mintignore`](/zh/organize/mintignore) 文件中列出的路径。 + +站点名称取自该目录或其父目录中 `package.json` 文件的 `name` 字段。如果没有 `package.json` 文件，CLI 会使用目录名称。编辑生成的 `docs.json` 文件以自定义你的导航、主题和颜色。 + 如果你在 VS Code 或 Cursor 中写作，[Mintlify MDX 扩展](/zh/cli/mdx-extension)会在编辑器旁的面板中运行此预览，并滚动到与你正在编辑的页面相匹配的位置。