Skip to content
Merged
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
36 changes: 36 additions & 0 deletions cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,42 @@

---

## `mint add-domain`

Add a [custom domain](/customize/custom-domain) to your deployment from the terminal. Requires authentication with `mint login`.

```bash
mint add-domain <domain>
```

| Argument | Description |
| --- | --- |
| `domain` | The custom domain to add, like `docs.example.com`. Must be a bare hostname. |

The command uses your configured subdomain from `mint config`. If you do not have a configured subdomain, it uses the first subdomain on your account.

After registering the domain, the CLI waits up to 10 seconds for DNS records to generate, then prints the `TXT` and `CNAME` records to add at your domain provider:

```text
TXT _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders
```

Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details.

<Note>
If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard for the remaining values.
</Note>

### Example

```bash
mint add-domain docs.example.com
```

---

## `mint automations`

Create, list, and delete [automations](/automations) from the terminal. Requires authentication with `mint login`.
Expand Down Expand Up @@ -247,7 +283,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 286 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L286

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L466

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L472

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

---

Expand Down
4 changes: 4 additions & 0 deletions customize/custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ If your domain traffic routes to Mintlify, the dashboard displays the DNS record

If you proxy only your subpath to Mintlify, the dashboard displays reverse proxy setup guides instead. Follow the guide for your provider and see [Host docs at a subpath](/deploy/docs-subpath) for more information.

<Tip>
You can also add a domain from the terminal with [`mint add-domain <domain>`](/cli/commands#mint-add-domain). The command registers the domain on your deployment and prints the DNS records to configure.
</Tip>

### Base path requirements

Your base path can be any path that meets these requirements:
Expand Down
38 changes: 38 additions & 0 deletions es/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,44 @@ mint status

---

<div id="mint-add-domain">
## `mint add-domain`
</div>

Añade un [dominio personalizado](/es/customize/custom-domain) a tu implementación desde la terminal. Requiere autenticación con `mint login`.

```bash
mint add-domain <domain>
```

| Argumento | Descripción |
| --- | --- |
| `domain` | El dominio personalizado que quieres añadir, como `docs.example.com`. Debe ser un nombre de host simple. |

El comando usa el subdominio configurado con `mint config`. Si no hay ninguno configurado, usa el primer subdominio de tu cuenta.

Una vez registrado el dominio, la CLI espera hasta 10 segundos a que se generen los registros DNS y luego imprime los registros `TXT` y `CNAME` que debes añadir en tu proveedor de dominio:

```text
TXT _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders
```

Añade primero los registros `TXT` y, una vez validados, añade el `CNAME`. Consulta [Dominio personalizado](/es/customize/custom-domain) para ver las instrucciones completas de configuración de DNS, los requisitos para dominios apex y los detalles del aprovisionamiento de TLS.

<Note>
Si algunos registros `TXT` aún se están generando cuando el comando finaliza, revisa la página de [Configuración de dominio personalizado](https://app.mintlify.com/settings/deployment/custom-domain) en tu panel para ver los valores restantes.
</Note>

### Ejemplo

```bash
mint add-domain docs.example.com
```

---

<div id="mint-automations">
## `mint automations`
</div>
Expand Down
4 changes: 4 additions & 0 deletions es/customize/custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ Si el tráfico de tu dominio se enruta a Mintlify, el dashboard muestra los regi

Si solo redireccionas tu subruta a Mintlify, el dashboard muestra guías de configuración de proxy inverso en su lugar. Sigue la guía correspondiente a tu proveedor y consulta [Alojar la documentación en una subruta](/es/deploy/docs-subpath) para más información.

<Tip>
También puedes añadir un dominio desde la terminal con [`mint add-domain <domain>`](/es/cli/commands#mint-add-domain). El comando registra el dominio en tu implementación e imprime los registros DNS que debes configurar.
</Tip>

<div id="base-path-requirements">
### Requisitos de la ruta base
</div>
Expand Down
40 changes: 40 additions & 0 deletions fr/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,46 @@ mint status

---

<div id="mint-add-domain">
## `mint add-domain`
</div>

Ajoutez un [domaine personnalisé](/fr/customize/custom-domain) à votre déploiement depuis le terminal. Nécessite une authentification avec `mint login`.

```bash
mint add-domain <domain>
```

| Argument | Description |
| --- | --- |
| `domain` | Le domaine personnalisé à ajouter, par exemple `docs.example.com`. Doit être un nom d'hôte simple. |

La commande utilise le sous-domaine configuré via `mint config`. Si aucun n'est défini, elle utilise le premier sous-domaine de votre compte.

Une fois le domaine enregistré, la CLI attend jusqu'à 10 secondes que les enregistrements DNS soient générés, puis affiche les enregistrements `TXT` et `CNAME` à ajouter chez votre fournisseur de domaine :

```text
TXT _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders
```

Ajoutez d'abord les enregistrements `TXT`, puis ajoutez le `CNAME` une fois les enregistrements de vérification validés. Consultez [Domaine personnalisé](/fr/customize/custom-domain) pour les instructions complètes de configuration DNS, les exigences pour les domaines apex et les détails sur le provisionnement TLS.

<Note>
Si certains enregistrements `TXT` sont encore en cours de génération à la fin de la commande, consultez la page [Configuration du domaine personnalisé](https://app.mintlify.com/settings/deployment/custom-domain) dans votre Dashboard pour récupérer les valeurs restantes.
</Note>

<div id="example-add-domain">
### Exemple
</div>

```bash
mint add-domain docs.example.com
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Locale files outside PR scope

Low Severity

This PR’s description scopes localization to English and Spanish, but the diff also changes French and Chinese pages. .mintlify/AGENTS.md says docs PRs should only edit English and leave es/, fr/, and zh/ to the translation workflow, so these locale edits look out of scope and risk conflicting with that process.

Additional Locations (2)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 616b8a0. Configure here.


---

<div id="mint-automations">
## `mint automations`
</div>
Expand Down
4 changes: 4 additions & 0 deletions fr/customize/custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ Si le trafic de votre domaine est acheminé vers Mintlify, le Dashboard affiche

Si vous ne transmettez que votre sous-chemin à Mintlify via un proxy, le Dashboard affiche à la place des guides de configuration de proxy inverse. Suivez le guide correspondant à votre fournisseur et consultez [Héberger la documentation sur un sous-chemin](/fr/deploy/docs-subpath) pour plus d’informations.

<Tip>
Vous pouvez également ajouter un domaine depuis le terminal avec [`mint add-domain <domain>`](/fr/cli/commands#mint-add-domain). La commande enregistre le domaine sur votre déploiement et affiche les enregistrements DNS à configurer.
</Tip>

<div id="base-path-requirements">
### Exigences relatives au chemin de base
</div>
Expand Down
40 changes: 40 additions & 0 deletions zh/cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,46 @@ mint status

---

<div id="mint-add-domain">
## `mint add-domain`
</div>

从终端为你的部署添加一个[自定义域名](/zh/customize/custom-domain)。需要使用 `mint login` 进行身份验证。

```bash
mint add-domain <domain>
```

| 参数 | 描述 |
| --- | --- |
| `domain` | 要添加的自定义域名,例如 `docs.example.com`。必须是纯主机名。 |

该命令使用通过 `mint config` 配置的子域名。如果未设置,则使用账户中的第一个子域名。

域名注册后,CLI 将等待最长 10 秒以生成 DNS 记录,然后打印需要在你的域名提供商处添加的 `TXT` 和 `CNAME` 记录:

```text
TXT _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders
```

请先添加 `TXT` 记录,验证记录通过后再添加 `CNAME`。有关完整的 DNS 配置说明、顶级域名要求和 TLS 配置详情,请参见[自定义域名](/zh/customize/custom-domain)。

<Note>
如果命令结束时某些 `TXT` 记录仍在生成中,请稍后前往控制台的 [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) 页面查看剩余的值。
</Note>

<div id="example-add-domain">
### 示例
</div>

```bash
mint add-domain docs.example.com
```

---

<div id="mint-automations">
## `mint automations`
</div>
Expand Down
4 changes: 4 additions & 0 deletions zh/customize/custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ keywords: ["自定义域名配置", "DNS 配置", "CNAME 记录", "TLS 证书",

如果你只是将子路径代理到 Mintlify,控制台会改为显示反向代理的设置指南。请按照适用于你提供商的指南操作,并参阅 [在子路径下托管文档](/zh/deploy/docs-subpath) 获取更多信息。

<Tip>
你也可以从终端使用 [`mint add-domain <domain>`](/zh/cli/commands#mint-add-domain) 添加域名。该命令会在你的部署上注册该域名,并打印需要配置的 DNS 记录。
</Tip>

<div id="base-path-requirements">
### 基础路径要求
</div>
Expand Down