From 93b47681e3b1da15c951b5545da0019a8fc04002 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:09:15 +0000 Subject: [PATCH 1/2] docs: clarify mintignore, sourceRef, monorepo toggle, static export domain --- api/static-export/start-job.mdx | 2 ++ deploy/monorepo.mdx | 6 +++--- deploy/multi-repo.mdx | 2 +- organize/mintignore.mdx | 4 ++++ static-export-openapi.json | 2 +- 5 files changed, 11 insertions(+), 5 deletions(-) diff --git a/api/static-export/start-job.mdx b/api/static-export/start-job.mdx index 7c91a586bf..e28650b332 100644 --- a/api/static-export/start-job.mdx +++ b/api/static-export/start-job.mdx @@ -8,3 +8,5 @@ keywords: ["static export", "job", "start", "bundle", "enterprise"] Static export requires an [Enterprise plan](https://mintlify.com/pricing?ref=static-export). +The `domain` field is the hostname where your documentation is served — the custom domain configured for your project in the Mintlify dashboard (for example, `docs.example.com`), or your Mintlify subdomain (for example, `acme.mintlify.app`) if you haven't set a custom domain. Pass the hostname only, without the protocol or any path prefix. + diff --git a/deploy/monorepo.mdx b/deploy/monorepo.mdx index 2dff74df46..6b98dbe5a5 100644 --- a/deploy/monorepo.mdx +++ b/deploy/monorepo.mdx @@ -37,18 +37,18 @@ Navigate to [Git Settings](https://app.mintlify.com/settings/deployment/git-sett The project settings panel in the Git Settings menu. The Set up as monorepo toggle button is enabled and a path to the /docs directory is specified. The project settings panel in the Git Settings menu. The Set up as monorepo toggle button is enabled and a path to the /docs directory is specified. -1. Click the **Set up as monorepo** toggle. +1. Enable the **docs.json is in a subdirectory** toggle. 2. Enter the relative path to your docs directory. For example, if your docs are in the `docs` directory, enter `/docs`. Do not include a trailing slash in the path. diff --git a/deploy/multi-repo.mdx b/deploy/multi-repo.mdx index 300201f8e7..a39e4cbf19 100644 --- a/deploy/multi-repo.mdx +++ b/deploy/multi-repo.mdx @@ -186,7 +186,7 @@ Add a `sourceRef` entry to a navigation array in the base source's `docs.json`. { "sourceRef": "acme/api-docs" } ``` -Mintlify supports `sourceRef` inside `anchors`, `tabs`, `groups`, `pages`, `products`, and arrays under `navigation.global`. +Mintlify supports `sourceRef` inside `anchors`, `tabs`, `groups`, `pages`, `products`, and arrays under `navigation.global`. Other navigation structures, including `menu` entries inside a tab, don't accept `sourceRef`. For example, to combine anchors from multiple repositories into a single anchor navigation: diff --git a/organize/mintignore.mdx b/organize/mintignore.mdx index c02ce4b31c..07566c8a3d 100644 --- a/organize/mintignore.mdx +++ b/organize/mintignore.mdx @@ -64,6 +64,10 @@ You don't need to add these to your `.mintignore` file. matching files from your site. Visitors cannot access them by URL. + + `.mintignore` controls what gets processed and published, not what triggers a deployment. Changes to files or directories matched by `.mintignore` still trigger a build and a preview deployment for the pull request. The excluded files are then dropped during processing and don't appear on the resulting site. + + ## Pattern syntax The `.mintignore` file follows `.gitignore` syntax. Some common patterns include: diff --git a/static-export-openapi.json b/static-export-openapi.json index 83cb61a293..febd996535 100644 --- a/static-export-openapi.json +++ b/static-export-openapi.json @@ -201,7 +201,7 @@ "properties": { "domain": { "type": "string", - "description": "The domain of the deployment to export, for example `docs.example.com`.", + "description": "The primary domain of the deployment to export. Use the custom domain configured for your project in the Mintlify dashboard (for example, `docs.example.com`). If you haven't configured a custom domain, use your Mintlify subdomain (for example, `acme.mintlify.app`). Provide the hostname only — do not include the protocol, a trailing slash, or a path prefix such as `/docs`.", "example": "docs.example.com" }, "version": { From 1520a050114a3a34da3e6ba23337c4f8c99b0142 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 7 Jul 2026 13:13:13 +0000 Subject: [PATCH 2/2] docs: mirror translations for mintignore/multi-repo/monorepo/static-export updates --- es/api/static-export/start-job.mdx | 2 ++ es/deploy/monorepo.mdx | 6 +++--- es/deploy/multi-repo.mdx | 2 +- es/organize/mintignore.mdx | 4 ++++ es/static-export-openapi.json | 2 +- fr/api/static-export/start-job.mdx | 2 ++ fr/deploy/monorepo.mdx | 6 +++--- fr/deploy/multi-repo.mdx | 2 +- fr/organize/mintignore.mdx | 4 ++++ fr/static-export-openapi.json | 2 +- zh/api/static-export/start-job.mdx | 2 ++ zh/deploy/monorepo.mdx | 6 +++--- zh/deploy/multi-repo.mdx | 2 +- zh/organize/mintignore.mdx | 4 ++++ zh/static-export-openapi.json | 2 +- 15 files changed, 33 insertions(+), 15 deletions(-) diff --git a/es/api/static-export/start-job.mdx b/es/api/static-export/start-job.mdx index 97ed23c88b..6df85b88e3 100644 --- a/es/api/static-export/start-job.mdx +++ b/es/api/static-export/start-job.mdx @@ -8,3 +8,5 @@ keywords: ["static export", "job", "start", "bundle", "enterprise"] La exportación estática requiere un [plan Enterprise](https://mintlify.com/pricing?ref=static-export). +El campo `domain` es el nombre de host donde se sirve tu documentación: el dominio personalizado configurado para tu proyecto en el dashboard de Mintlify (por ejemplo, `docs.example.com`), o tu subdominio de Mintlify (por ejemplo, `acme.mintlify.app`) si no has configurado un dominio personalizado. Pasa únicamente el nombre de host, sin el protocolo ni ningún prefijo de ruta. + diff --git a/es/deploy/monorepo.mdx b/es/deploy/monorepo.mdx index f29bc91b4b..74835700fd 100644 --- a/es/deploy/monorepo.mdx +++ b/es/deploy/monorepo.mdx @@ -41,18 +41,18 @@ Ve a [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-setti El panel de configuración del proyecto en el menú Git Settings. El botón Set up as monorepo está activado y se especifica una ruta al directorio /docs. El panel de configuración del proyecto en el menú Git Settings. El botón Set up as monorepo está activado y se especifica una ruta al directorio /docs. -1. Activa el interruptor **Set up as monorepo**. +1. Activa el interruptor **docs.json is in a subdirectory**. 2. Ingresa la ruta relativa a tu directorio de documentación. Por ejemplo, si tu documentación está en el directorio `docs`, ingresa `/docs`. No incluyas una barra final en la ruta. diff --git a/es/deploy/multi-repo.mdx b/es/deploy/multi-repo.mdx index 7e52e6dd8b..cbcdba6c41 100644 --- a/es/deploy/multi-repo.mdx +++ b/es/deploy/multi-repo.mdx @@ -204,7 +204,7 @@ Agrega una entrada `sourceRef` a un arreglo de navegación en el `docs.json` de { "sourceRef": "acme/api-docs" } ``` -Mintlify admite `sourceRef` dentro de `anchors`, `tabs`, `groups`, `pages`, `products` y los arreglos bajo `navigation.global`. +Mintlify admite `sourceRef` dentro de `anchors`, `tabs`, `groups`, `pages`, `products` y los arreglos bajo `navigation.global`. Otras estructuras de navegación, incluidas las entradas de `menu` dentro de una pestaña, no aceptan `sourceRef`. Por ejemplo, para combinar los anchors de varios repositorios en una sola navegación de anchors: diff --git a/es/organize/mintignore.mdx b/es/organize/mintignore.mdx index 1c2a66aca0..f6f8ec5da5 100644 --- a/es/organize/mintignore.mdx +++ b/es/organize/mintignore.mdx @@ -67,6 +67,10 @@ No necesitas añadirlos a tu archivo `.mintignore`. A diferencia de las [páginas ocultas](/es/organize/hidden-pages), `.mintignore` elimina completamente los archivos coincidentes de tu sitio. Los visitantes no pueden acceder a ellos mediante una URL. + + `.mintignore` controla qué se procesa y se publica, no qué desencadena un despliegue. Los cambios en archivos o directorios que coincidan con `.mintignore` seguirán activando una compilación y un despliegue de vista previa para el pull request. Los archivos excluidos se descartan durante el procesamiento y no aparecen en el sitio resultante. + +
## Sintaxis de patrones
diff --git a/es/static-export-openapi.json b/es/static-export-openapi.json index ec7afac50a..a4770595a8 100644 --- a/es/static-export-openapi.json +++ b/es/static-export-openapi.json @@ -201,7 +201,7 @@ "properties": { "domain": { "type": "string", - "description": "El dominio de la implementación que se va a exportar, por ejemplo `docs.example.com`.", + "description": "El dominio principal de la implementación que se va a exportar. Usa el dominio personalizado configurado para tu proyecto en el dashboard de Mintlify (por ejemplo, `docs.example.com`). Si no has configurado un dominio personalizado, usa tu subdominio de Mintlify (por ejemplo, `acme.mintlify.app`). Proporciona solo el nombre de host: no incluyas el protocolo, una barra final ni un prefijo de ruta como `/docs`.", "example": "docs.example.com" }, "version": { diff --git a/fr/api/static-export/start-job.mdx b/fr/api/static-export/start-job.mdx index 6132b0588e..7414a42e39 100644 --- a/fr/api/static-export/start-job.mdx +++ b/fr/api/static-export/start-job.mdx @@ -7,3 +7,5 @@ keywords: ["static export", "job", "start", "bundle", "enterprise"] L'exportation statique nécessite un [forfait Enterprise](https://mintlify.com/pricing?ref=static-export). + +Le champ `domain` est le nom d'hôte sur lequel votre documentation est servie — le domaine personnalisé configuré pour votre projet dans le tableau de bord Mintlify (par exemple, `docs.example.com`), ou votre sous-domaine Mintlify (par exemple, `acme.mintlify.app`) si vous n'avez pas configuré de domaine personnalisé. Indiquez uniquement le nom d'hôte, sans le protocole ni aucun préfixe de chemin. diff --git a/fr/deploy/monorepo.mdx b/fr/deploy/monorepo.mdx index 8ebbe498f1..de7a7bc2f2 100644 --- a/fr/deploy/monorepo.mdx +++ b/fr/deploy/monorepo.mdx @@ -41,18 +41,18 @@ Accédez à [Git Settings](https://dashboard.mintlify.com/settings/deployment/gi Le panneau des paramètres du projet dans le menu Git Settings. L’option Configurer en tant que monorepo est activée et un chemin vers le répertoire /docs est renseigné. Le panneau des paramètres du projet dans le menu Git Settings. L’option Configurer en tant que monorepo est activée et un chemin vers le répertoire /docs est renseigné. -1. Activez l’option **Configurer en tant que monorepo**. +1. Activez l’option **docs.json is in a subdirectory**. 2. Saisissez le chemin relatif vers votre répertoire de documentation. Par exemple, si votre documentation se trouve dans le répertoire `docs`, saisissez `/docs`. N’incluez pas de barre oblique finale dans le chemin. diff --git a/fr/deploy/multi-repo.mdx b/fr/deploy/multi-repo.mdx index 362b39f562..7bdd098dc3 100644 --- a/fr/deploy/multi-repo.mdx +++ b/fr/deploy/multi-repo.mdx @@ -204,7 +204,7 @@ Ajoutez une entrée `sourceRef` à un tableau de navigation dans le `docs.json` { "sourceRef": "acme/api-docs" } ``` -Mintlify prend en charge `sourceRef` dans `anchors`, `tabs`, `groups`, `pages`, `products` et les tableaux sous `navigation.global`. +Mintlify prend en charge `sourceRef` dans `anchors`, `tabs`, `groups`, `pages`, `products` et les tableaux sous `navigation.global`. Les autres structures de navigation, y compris les entrées `menu` à l'intérieur d'un onglet, n'acceptent pas `sourceRef`. Par exemple, pour combiner les anchors de plusieurs référentiels dans une seule navigation d'anchors : diff --git a/fr/organize/mintignore.mdx b/fr/organize/mintignore.mdx index b7c1b1e8d3..94ab512957 100644 --- a/fr/organize/mintignore.mdx +++ b/fr/organize/mintignore.mdx @@ -68,6 +68,10 @@ Vous n’avez pas besoin de les ajouter à votre fichier `.mintignore`. les fichiers correspondants de votre site. Les visiteurs ne peuvent pas y accéder via leur URL. + + `.mintignore` contrôle ce qui est traité et publié, pas ce qui déclenche un déploiement. Les modifications apportées aux fichiers ou répertoires correspondant à `.mintignore` déclenchent toujours une compilation et un déploiement de prévisualisation pour la pull request. Les fichiers exclus sont ensuite supprimés lors du traitement et n'apparaissent pas sur le site généré. + +
## Syntaxe des motifs
diff --git a/fr/static-export-openapi.json b/fr/static-export-openapi.json index 9992df117e..89381c6205 100644 --- a/fr/static-export-openapi.json +++ b/fr/static-export-openapi.json @@ -201,7 +201,7 @@ "properties": { "domain": { "type": "string", - "description": "Le domaine du déploiement à exporter, par exemple `docs.example.com`.", + "description": "Le domaine principal du déploiement à exporter. Utilisez le domaine personnalisé configuré pour votre projet dans le tableau de bord Mintlify (par exemple, `docs.example.com`). Si vous n'avez pas configuré de domaine personnalisé, utilisez votre sous-domaine Mintlify (par exemple, `acme.mintlify.app`). Fournissez uniquement le nom d'hôte — n'incluez pas le protocole, ni une barre oblique finale, ni un préfixe de chemin tel que `/docs`.", "example": "docs.example.com" }, "version": { diff --git a/zh/api/static-export/start-job.mdx b/zh/api/static-export/start-job.mdx index 54f03a3c0a..f052e71698 100644 --- a/zh/api/static-export/start-job.mdx +++ b/zh/api/static-export/start-job.mdx @@ -7,3 +7,5 @@ keywords: ["static export", "job", "start", "bundle", "enterprise"] 静态导出需要 [Enterprise 套餐](https://mintlify.com/pricing?ref=static-export)。 + +`domain` 字段是提供你的文档服务的主机名——即你在 Mintlify 控制台中为项目配置的自定义域名（例如 `docs.example.com`）；如果你尚未设置自定义域名，则使用你的 Mintlify 子域名（例如 `acme.mintlify.app`）。仅传入主机名，不要包含协议或任何路径前缀。 diff --git a/zh/deploy/monorepo.mdx b/zh/deploy/monorepo.mdx index 436ab4eba9..b7780c8b0c 100644 --- a/zh/deploy/monorepo.mdx +++ b/zh/deploy/monorepo.mdx @@ -41,18 +41,18 @@ your-repo/ Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用，并指定了 /docs 目录的路径。 Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用，并指定了 /docs 目录的路径。 -1. 打开 **Set up as monorepo** 开关。 +1. 打开 **docs.json is in a subdirectory** 开关。 2. 输入文档目录的相对路径。例如，如果文档位于 `docs` 目录，输入 `/docs`。 路径末尾不要包含斜杠。 diff --git a/zh/deploy/multi-repo.mdx b/zh/deploy/multi-repo.mdx index 7afd19b7b3..f622c10389 100644 --- a/zh/deploy/multi-repo.mdx +++ b/zh/deploy/multi-repo.mdx @@ -204,7 +204,7 @@ See the [API reference](/api/reference/authentication) for details. { "sourceRef": "acme/api-docs" } ``` -Mintlify 支持在 `anchors`、`tabs`、`groups`、`pages`、`products` 以及 `navigation.global` 下的数组中使用 `sourceRef`。 +Mintlify 支持在 `anchors`、`tabs`、`groups`、`pages`、`products` 以及 `navigation.global` 下的数组中使用 `sourceRef`。其他导航结构（包括标签页内的 `menu` 条目）不支持 `sourceRef`。 例如，若要将多个仓库的 anchors 合并到单个 anchor 导航中： diff --git a/zh/organize/mintignore.mdx b/zh/organize/mintignore.mdx index 31d6f8afbc..e4e9498ad7 100644 --- a/zh/organize/mintignore.mdx +++ b/zh/organize/mintignore.mdx @@ -66,6 +66,10 @@ Mintlify 会自动忽略以下目录和文件，无需任何配置： 与[隐藏页面](/zh/organize/hidden-pages)不同，`.mintignore` 会将匹配的文件从你的站点中完全移除。访问者无法通过 URL 访问这些文件。 + + `.mintignore` 控制哪些文件会被处理和发布，而不是控制哪些更改会触发部署。对与 `.mintignore` 匹配的文件或目录所做的更改仍会触发构建以及针对该 pull request 的预览部署。被排除的文件随后在处理过程中被丢弃，不会出现在生成的站点上。 + +
## 模式语法
diff --git a/zh/static-export-openapi.json b/zh/static-export-openapi.json index 6dd93a2313..c36bd2bf13 100644 --- a/zh/static-export-openapi.json +++ b/zh/static-export-openapi.json @@ -201,7 +201,7 @@ "properties": { "domain": { "type": "string", - "description": "要导出的部署所对应的域名，例如 `docs.example.com`。", + "description": "要导出的部署的主域名。使用你在 Mintlify 控制台中为项目配置的自定义域名（例如 `docs.example.com`）。如果尚未配置自定义域名，则使用你的 Mintlify 子域名（例如 `acme.mintlify.app`）。仅提供主机名——不要包含协议、结尾斜杠或诸如 `/docs` 之类的路径前缀。", "example": "docs.example.com" }, "version": {