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
2 changes: 2 additions & 0 deletions api/static-export/start-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@
Static export requires an [Enterprise plan](https://mintlify.com/pricing?ref=static-export).
</Info>

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.

Check warning on line 11 in api/static-export/start-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/start-job.mdx#L11

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

Check warning on line 11 in api/static-export/start-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/start-job.mdx#L11

Don't put a space before or after a dash.

6 changes: 3 additions & 3 deletions deploy/monorepo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,18 @@ Navigate to [Git Settings](https://app.mintlify.com/settings/deployment/git-sett
<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/monorepo-light.png"
alt="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."
alt="The project settings panel in the Git Settings menu, showing the docs.json is in a subdirectory toggle enabled and a path to the /docs directory specified."
/>
<img
className="hidden dark:block my-0 pointer-events-none"
src="/images/monorepo-dark.png"
alt="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."
alt="The project settings panel in the Git Settings menu, showing the docs.json is in a subdirectory toggle enabled and a path to the /docs directory specified."
/>
</Frame>

</Step>
<Step title="Set your documentation path">
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`.
<Note>
Do not include a trailing slash in the path.
Expand Down
2 changes: 1 addition & 1 deletion deploy/multi-repo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 2 additions & 0 deletions es/api/static-export/start-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
</Info>

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.

6 changes: 3 additions & 3 deletions es/deploy/monorepo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,18 @@ Ve a [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-setti
<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/monorepo-light.png"
alt="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."
alt="El panel de configuración del proyecto en el menú Git Settings, donde el interruptor docs.json is in a subdirectory está activado y se especifica una ruta al directorio /docs."
/>
<img
className="hidden dark:block my-0 pointer-events-none"
src="/images/monorepo-dark.png"
alt="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."
alt="El panel de configuración del proyecto en el menú Git Settings, donde el interruptor docs.json is in a subdirectory está activado y se especifica una ruta al directorio /docs."
/>
</Frame>

</Step>
<Step title="Define la ruta de tu documentación">
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`.
<Note>
No incluyas una barra final en la ruta.
Expand Down
2 changes: 1 addition & 1 deletion es/deploy/multi-repo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 4 additions & 0 deletions es/organize/mintignore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Note>

<Note>
`.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.
</Note>

<div id="pattern-syntax">
## Sintaxis de patrones
</div>
Expand Down
2 changes: 1 addition & 1 deletion es/static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 2 additions & 0 deletions fr/api/static-export/start-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ keywords: ["static export", "job", "start", "bundle", "enterprise"]
<Info>
L'exportation statique nécessite un [forfait Enterprise](https://mintlify.com/pricing?ref=static-export).
</Info>

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.
6 changes: 3 additions & 3 deletions fr/deploy/monorepo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,18 @@ Accédez à [Git Settings](https://dashboard.mintlify.com/settings/deployment/gi
<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/monorepo-light.png"
alt="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é."
alt="Le panneau des paramètres du projet dans le menu Git Settings, avec l’option docs.json is in a subdirectory activée et un chemin vers le répertoire /docs renseigné."
/>
<img
className="hidden dark:block my-0 pointer-events-none"
src="/images/monorepo-dark.png"
alt="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é."
alt="Le panneau des paramètres du projet dans le menu Git Settings, avec l’option docs.json is in a subdirectory activée et un chemin vers le répertoire /docs renseigné."
/>
</Frame>

</Step>
<Step title="Définir le chemin de votre documentation">
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`.
<Note>
N’incluez pas de barre oblique finale dans le chemin.
Expand Down
2 changes: 1 addition & 1 deletion fr/deploy/multi-repo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 :

Expand Down
4 changes: 4 additions & 0 deletions fr/organize/mintignore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Note>

<Note>
`.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é.
</Note>

<div id="pattern-syntax">
## Syntaxe des motifs
</div>
Expand Down
2 changes: 1 addition & 1 deletion fr/static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
4 changes: 4 additions & 0 deletions organize/mintignore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Note>

<Note>
`.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.
</Note>

## Pattern syntax

The `.mintignore` file follows `.gitignore` syntax. Some common patterns include:
Expand Down
2 changes: 1 addition & 1 deletion static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 2 additions & 0 deletions zh/api/static-export/start-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ keywords: ["static export", "job", "start", "bundle", "enterprise"]
<Info>
静态导出需要 [Enterprise 套餐](https://mintlify.com/pricing?ref=static-export)。
</Info>

`domain` 字段是提供你的文档服务的主机名——即你在 Mintlify 控制台中为项目配置的自定义域名(例如 `docs.example.com`);如果你尚未设置自定义域名,则使用你的 Mintlify 子域名(例如 `acme.mintlify.app`)。仅传入主机名,不要包含协议或任何路径前缀。
6 changes: 3 additions & 3 deletions zh/deploy/monorepo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,18 @@ your-repo/
<img
className="block dark:hidden my-0 pointer-events-none"
src="/images/monorepo-light.png"
alt="Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用,并指定了 /docs 目录的路径。"
alt="Git Settings 菜单中的项目设置面板,其中 docs.json is in a subdirectory 开关已启用,并指定了 /docs 目录的路径。"
/>
<img
className="hidden dark:block my-0 pointer-events-none"
src="/images/monorepo-dark.png"
alt="Git Settings 菜单中的项目设置面板。Set up as monorepo 开关已启用,并指定了 /docs 目录的路径。"
alt="Git Settings 菜单中的项目设置面板,其中 docs.json is in a subdirectory 开关已启用,并指定了 /docs 目录的路径。"
/>
</Frame>

</Step>
<Step title="设置文档路径">
1. 打开 **Set up as monorepo** 开关。
1. 打开 **docs.json is in a subdirectory** 开关。
2. 输入文档目录的相对路径。例如,如果文档位于 `docs` 目录,输入 `/docs`。
<Note>
路径末尾不要包含斜杠。
Expand Down
2 changes: 1 addition & 1 deletion zh/deploy/multi-repo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 导航中:

Expand Down
4 changes: 4 additions & 0 deletions zh/organize/mintignore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ Mintlify 会自动忽略以下目录和文件,无需任何配置:
与[隐藏页面](/zh/organize/hidden-pages)不同,`.mintignore` 会将匹配的文件从你的站点中完全移除。访问者无法通过 URL 访问这些文件。
</Note>

<Note>
`.mintignore` 控制哪些文件会被处理和发布,而不是控制哪些更改会触发部署。对与 `.mintignore` 匹配的文件或目录所做的更改仍会触发构建以及针对该 pull request 的预览部署。被排除的文件随后在处理过程中被丢弃,不会出现在生成的站点上。
</Note>

<div id="pattern-syntax">
## 模式语法
</div>
Expand Down
2 changes: 1 addition & 1 deletion zh/static-export-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
Loading