diff --git a/components/tree.mdx b/components/tree.mdx index a88aadfa76..db4e6dbff3 100644 --- a/components/tree.mdx +++ b/components/tree.mdx @@ -9,6 +9,8 @@ Use tree components to display hierarchical structures like file systems, projec Create trees with either a Markdown list or the `Tree.Folder` and `Tree.File` components. `` and `` are aliases, so either tag works with either syntax. +Use the Markdown list syntax for quick, static trees where every folder can expand by default. Use the component syntax when you need to control open state per folder with `defaultOpen`, mark folders as non-interactive with `openable`, or mix files and folders at arbitrary depth. + ## Markdown list syntax Write a nested Markdown list inside `` (or ``) to describe a folder structure. Add a trailing slash to mark a folder, or nest items under it. Folders that contain nested items expand by default. diff --git a/create/text.mdx b/create/text.mdx index 856da3c122..ac657ceb83 100644 --- a/create/text.mdx +++ b/create/text.mdx @@ -36,6 +36,19 @@ By default, Mintlify generates an anchor ID from the heading text. Generated IDs When a page has multiple headings that generate the same ID, Mintlify adds `-2`, `-3`, and so on. The counter applies across the entire page, including headings nested inside components such as tabs. +The following examples show how heading text maps to a generated anchor ID: + +| Heading text | Generated ID | +| :--- | :--- | +| `Getting started` | `getting-started` | +| `Config.json options` | `config-json-options` | +| `What's new` | `what’s-new` | +| `Rate limits (per minute)` | `rate-limits-per-minute` | +| `Read/write access` | `read/write-access` | +| `Fees & billing` | `fees-&-billing` | +| `OAuth` | `oauth` | +| Duplicate `Overview` heading | `overview-2` | + Mintlify's anchor IDs do not use GitHub-style slugging. Percent-encode non-ASCII characters when constructing a URL programmatically. diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx index 9f0d945bb5..fa5df7c44c 100644 --- a/dashboard/audit-logs.mdx +++ b/dashboard/audit-logs.mdx @@ -79,6 +79,32 @@ Organization admins can add multiple destinations and choose which categories to 5. Click **Add destination**. + + + Create an IAM user (or role with programmatic access credentials) whose policy allows writing to the target bucket. At minimum, grant `s3:PutObject` on the bucket and key prefix that you plan to use. For example: + + ```json + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": ["s3:PutObject"], + "Resource": "arn:aws:s3:::your-bucket-name/audit-logs/*" + } + ] + } + ``` + + Use the access key ID and secret access key from that IAM user when adding the destination. The key prefix is optional and is prepended to every object that Mintlify writes. + + + Create a Datadog API key from **Organization Settings > API Keys** in your Datadog account. Do not use an application key. + + Set the Datadog site to match the region where you host your Datadog account, for example `datadoghq.com` (US1), `us3.datadoghq.com`, `us5.datadoghq.com`, `datadoghq.eu` (EU1), `ap1.datadoghq.com`, or `ddog-gov.com`. Using the wrong site rejects the events. + + + To stop streaming to a destination, open the streaming configuration and click the remove icon next to the destination. ### Select streamed categories @@ -93,6 +119,6 @@ To stop streaming to a destination, open the streaming configuration and click t Export audit logs to CSV for analysis, compliance reporting, or long-term archival. 1. Navigate to the [Audit log](https://app.mintlify.com/settings/organization/audit-logs) page of your dashboard. -1. Optionally, apply filters to narrow down the logs you want to export. -1. Click **Export CSV**. -1. Mintlify sends you an email with a download link when the export is ready. +2. Optionally, apply filters to narrow down the logs you want to export. +3. Click **Export CSV**. +4. Mintlify sends you an email with a download link when the export is ready. diff --git a/es/agent/index.mdx b/es/agent/index.mdx index 686c03e339..d52dd588df 100644 --- a/es/agent/index.mdx +++ b/es/agent/index.mdx @@ -16,6 +16,16 @@ El agente es una herramienta de IA que crea solicitudes de extracción (pull req * **Valida**: Ejecuta comprobaciones con Mintlify CLI para asegurarse de que la documentación se compile correctamente. * **Publica los cambios**: Abre una solicitud de extracción con los cambios propuestos para revisión, o realiza confirmaciones directamente en tu branch de despliegue, según tu [ajuste de proceso de revisión](/es/agent/index#choose-how-the-agent-publishes-changes). +
+ ## Cómo usar el agente +
+ +Puedes enviar indicaciones al agente desde: + +- **Slack**: Menciona a `@Mintlify` en cualquier canal en el que esté el agente, o envía un mensaje directo a la aplicación. Consulta [Añadir el agente a Slack](/es/agent/slack). +- **El dashboard**: Abre el panel del agente desde el [dashboard de Mintlify](https://app.mintlify.com) para iniciar una nueva conversación. +- **Automatizaciones**: Activa el agente según una programación o a partir de un evento. Consulta [Automatizaciones](/es/automations/index). +
## Qué puedes hacer con el agente
diff --git a/es/components/tree.mdx b/es/components/tree.mdx index 2bf2b8fc11..5005049eeb 100644 --- a/es/components/tree.mdx +++ b/es/components/tree.mdx @@ -9,6 +9,8 @@ Utiliza componentes de árbol para mostrar estructuras jerárquicas como sistema Puedes crear árboles con una lista de Markdown o con los componentes `Tree.Folder` y `Tree.File`. `` y `` son alias, por lo que cualquiera de las etiquetas funciona con cualquiera de las sintaxis. +Usa la sintaxis de lista de Markdown para árboles rápidos y estáticos en los que cada carpeta puede expandirse de forma predeterminada. Usa la sintaxis de componente cuando necesites controlar el estado de apertura de cada carpeta con `defaultOpen`, marcar carpetas como no interactivas con `openable`, o mezclar archivos y carpetas a una profundidad arbitraria. +
## Sintaxis de lista de Markdown
@@ -175,4 +177,6 @@ El componente de árbol admite la navegación con el teclado. El nombre del archivo que se muestra en el árbol. - \ No newline at end of file + + +`Tree.File` solo acepta la prop `name`. \ No newline at end of file diff --git a/es/create/text.mdx b/es/create/text.mdx index 6642b21862..b4950df8d1 100644 --- a/es/create/text.mdx +++ b/es/create/text.mdx @@ -42,6 +42,19 @@ De forma predeterminada, Mintlify genera un ID de anclaje a partir del texto del Cuando una página tiene varios encabezados que generan el mismo ID, Mintlify añade `-2`, `-3`, y así sucesivamente. El contador se aplica a toda la página, incluidos los encabezados anidados dentro de componentes como pestañas. +Los siguientes ejemplos muestran cómo el texto del encabezado se convierte en un ID de anclaje generado: + +| Texto del encabezado | ID generado | +| :--- | :--- | +| `Getting started` | `getting-started` | +| `Config.json options` | `config-json-options` | +| `What's new` | `what’s-new` | +| `Rate limits (per minute)` | `rate-limits-per-minute` | +| `Read/write access` | `read/write-access` | +| `Fees & billing` | `fees-&-billing` | +| `OAuth` | `oauth` | +| Encabezado `Overview` duplicado | `overview-2` | + Los IDs de anclaje de Mintlify no usan el estilo de slug de GitHub. Codifica en porcentaje los caracteres no ASCII cuando construyas una URL de forma programática. diff --git a/es/dashboard/audit-logs.mdx b/es/dashboard/audit-logs.mdx index ab83d09218..79a3ddb6dd 100644 --- a/es/dashboard/audit-logs.mdx +++ b/es/dashboard/audit-logs.mdx @@ -87,6 +87,32 @@ Los administradores de la organización pueden agregar varios destinos y elegir 5. Haz clic en **Add destination**. + + + Crea un usuario de IAM (o un rol con credenciales de acceso programático) cuya política permita escribir en el bucket de destino. Como mínimo, otorga `s3:PutObject` en el bucket y el prefijo de clave que planeas usar. Por ejemplo: + + ```json + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": ["s3:PutObject"], + "Resource": "arn:aws:s3:::your-bucket-name/audit-logs/*" + } + ] + } + ``` + + Usa el access key ID y el secret access key de ese usuario de IAM al agregar el destino. El prefijo de clave es opcional y se antepone a cada objeto que Mintlify escribe. + + + Crea una API key de Datadog desde **Organization Settings > API Keys** en tu cuenta de Datadog. No uses una application key. + + Configura el sitio de Datadog para que coincida con la región donde está alojada tu cuenta de Datadog, por ejemplo `datadoghq.com` (US1), `us3.datadoghq.com`, `us5.datadoghq.com`, `datadoghq.eu` (EU1), `ap1.datadoghq.com` o `ddog-gov.com`. Usar un sitio incorrecto hace que se rechacen los eventos. + + + Para dejar de transmitir a un destino, abre la configuración de transmisión y haz clic en el icono de eliminación junto al destino.
@@ -105,6 +131,6 @@ Para dejar de transmitir a un destino, abre la configuración de transmisión y Exporta los registros de auditoría a CSV para su análisis, generación de informes de cumplimiento o archivo a largo plazo. 1. Dirígete a la página de [Audit log](https://app.mintlify.com/settings/organization/audit-logs) de tu dashboard. -1. Opcionalmente, aplica filtros para acotar los registros que quieres exportar. -1. Haz clic en **Export CSV**. -1. Mintlify te envía un correo electrónico con un enlace de descarga cuando la exportación esté lista. +2. Opcionalmente, aplica filtros para acotar los registros que quieres exportar. +3. Haz clic en **Export CSV**. +4. Mintlify te envía un correo electrónico con un enlace de descarga cuando la exportación esté lista. diff --git a/es/guides/claude-code.mdx b/es/guides/claude-code.mdx index f243babfc7..f90492fc1a 100644 --- a/es/guides/claude-code.mdx +++ b/es/guides/claude-code.mdx @@ -29,6 +29,7 @@ Puedes entrenar a Claude Code para que comprenda tus estándares y flujos de tra 3. (Opcional) Añade el archivo `CLAUDE.md` a tu proyecto. 4. Ejecuta `claude` para empezar. +Para confirmar tu configuración, hazle a Claude Code una pregunta como `Summarize the standards from CLAUDE.md and list the Mintlify components you can use`. Una sesión que funcione correctamente cita tu `CLAUDE.md` y hace referencia a componentes de Mintlify (por ejemplo, `Card`, `Steps` o `Accordion`) del skill cargado.
## Plantilla para CLAUDE.md diff --git a/es/guides/codex.mdx b/es/guides/codex.mdx index 52cfc7916b..a2b0c17463 100644 --- a/es/guides/codex.mdx +++ b/es/guides/codex.mdx @@ -170,7 +170,7 @@ Verifica si esta nueva página sigue los estándares de redacción definidos en Conecta el servidor MCP de Mintlify a Codex para darle acceso a buscar en la documentación de Mintlify mientras te ayuda a escribir. Cuando conectas el servidor MCP, Codex puede consultar el uso de los componentes y las opciones de configuración sin que tengas que salir de la terminal. -Agrega el servidor MCP a tu configuración global de Codex en `~/.codex/config.toml`: +Agrega el servidor MCP a tu configuración global de Codex en `~/.codex/config.toml`. Crea el archivo si no existe: ```toml [mcp_servers.mintlify] @@ -184,4 +184,8 @@ Para conectarte en su lugar al servidor MCP de tu propio sitio de documentación url = "https://your-docs.mintlify.site/mcp" ``` +Reinicia tu sesión de `codex` para que el cambio de configuración surta efecto. Para confirmar que el servidor MCP está conectado, pregúntale a Codex `Which MCP servers do you have access to?`: debería enumerar la entrada que acabas de añadir. + +Usar `config.toml` registra el servidor MCP para todas las sesiones de Codex en tu equipo. La indicación de skill y MCP en sesión mostrada anteriormente carga el mismo contexto bajo demanda dentro de una sola sesión: úsala para una ejecución puntual o cuando no puedas editar `config.toml`. + Consulta [Model Context Protocol](/es/ai/model-context-protocol) para obtener más información sobre los servidores MCP y cómo encontrar el endpoint MCP de tu sitio. diff --git a/fr/agent/index.mdx b/fr/agent/index.mdx index 671e4cdb7e..aeddac1470 100644 --- a/fr/agent/index.mdx +++ b/fr/agent/index.mdx @@ -16,6 +16,16 @@ L'agent est un outil d'IA qui crée des pull requests (demandes de fusion) avec * **Valide** : exécute les vérifications de l'Interface en ligne de commande (CLI) Mintlify pour s'assurer que la documentation se génère correctement. * **Publie les modifications** : ouvre une pull request (demande de fusion) avec les modifications proposées pour relecture, ou pousse les modifications directement sur votre branche de déploiement, selon votre [paramètre de processus de relecture](/fr/agent/index#choose-how-the-agent-publishes-changes). +
+ ## Comment utiliser l'agent +
+ +Vous pouvez envoyer des prompts à l'agent depuis : + +- **Slack** : mentionnez `@Mintlify` dans n'importe quel canal auquel l'agent appartient, ou envoyez un message direct à l'application. Consultez [Ajouter l'agent à Slack](/fr/agent/slack). +- **Le dashboard** : ouvrez le panneau de l'agent depuis le [dashboard Mintlify](https://app.mintlify.com) pour démarrer une nouvelle conversation. +- **Automatisations** : déclenchez l'agent selon un planning ou à partir d'un événement. Consultez [Automatisations](/fr/automations/index). +
## Ce que vous pouvez faire avec l’agent
diff --git a/fr/components/tree.mdx b/fr/components/tree.mdx index b692f8e476..48f8282e1d 100644 --- a/fr/components/tree.mdx +++ b/fr/components/tree.mdx @@ -9,6 +9,8 @@ Utilisez des composants arborescents pour afficher des structures hiérarchiques Vous pouvez créer des arborescences avec une liste Markdown ou avec les composants `Tree.Folder` et `Tree.File`. `` et `` sont des alias : chaque balise fonctionne avec l’une ou l’autre des syntaxes. +Utilisez la syntaxe de liste Markdown pour des arborescences rapides et statiques dont chaque dossier peut se développer par défaut. Utilisez la syntaxe des composants lorsque vous devez contrôler l'état d'ouverture par dossier avec `defaultOpen`, marquer des dossiers comme non interactifs avec `openable`, ou mélanger des fichiers et des dossiers à une profondeur arbitraire. +
## Syntaxe de liste Markdown
@@ -175,4 +177,6 @@ Le composant d’arborescence prend en charge la navigation au clavier. Le nom du fichier affiché dans l'arborescence. - \ No newline at end of file + + +`Tree.File` n'accepte que la prop `name`. \ No newline at end of file diff --git a/fr/create/text.mdx b/fr/create/text.mdx index d96ac6b9b0..4f05db5055 100644 --- a/fr/create/text.mdx +++ b/fr/create/text.mdx @@ -42,6 +42,19 @@ Par défaut, Mintlify génère un ID d’ancrage à partir du texte du titre. Le Lorsqu’une page comporte plusieurs titres qui génèrent le même ID, Mintlify ajoute `-2`, `-3`, et ainsi de suite. Le compteur s’applique à l’ensemble de la page, y compris aux titres imbriqués dans des composants tels que les onglets. +Les exemples suivants montrent comment le texte d’un titre est converti en ID d’ancrage généré : + +| Texte de l'en-tête | ID généré | +| :--- | :--- | +| `Getting started` | `getting-started` | +| `Config.json options` | `config-json-options` | +| `What's new` | `what’s-new` | +| `Rate limits (per minute)` | `rate-limits-per-minute` | +| `Read/write access` | `read/write-access` | +| `Fees & billing` | `fees-&-billing` | +| `OAuth` | `oauth` | +| En-tête `Overview` en double | `overview-2` | + Les IDs d’ancrage de Mintlify n’utilisent pas le slug de style GitHub. Encodez en pourcentage les caractères non ASCII lors de la construction programmatique d’une URL. diff --git a/fr/dashboard/audit-logs.mdx b/fr/dashboard/audit-logs.mdx index 597016ebcf..9c5143d1d8 100644 --- a/fr/dashboard/audit-logs.mdx +++ b/fr/dashboard/audit-logs.mdx @@ -87,6 +87,32 @@ Les administrateurs de l'organisation peuvent ajouter plusieurs destinations et 5. Cliquez sur **Add destination**. + + + Créez un utilisateur IAM (ou un rôle disposant d'identifiants d'accès programmatique) dont la politique autorise l'écriture dans le bucket cible. Accordez au minimum l'action `s3:PutObject` sur le bucket et le préfixe de clé que vous prévoyez d'utiliser. Par exemple : + + ```json + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": ["s3:PutObject"], + "Resource": "arn:aws:s3:::your-bucket-name/audit-logs/*" + } + ] + } + ``` + + Utilisez l'access key ID et la secret access key de cet utilisateur IAM lors de l'ajout de la destination. Le préfixe de clé est facultatif et est ajouté au début de chaque objet écrit par Mintlify. + + + Créez une clé d'API Datadog depuis **Organization Settings > API Keys** dans votre compte Datadog. N'utilisez pas de clé d'application. + + Définissez le site Datadog afin qu'il corresponde à la région où votre compte Datadog est hébergé, par exemple `datadoghq.com` (US1), `us3.datadoghq.com`, `us5.datadoghq.com`, `datadoghq.eu` (EU1), `ap1.datadoghq.com` ou `ddog-gov.com`. L'utilisation d'un site incorrect entraîne le rejet des événements. + + + Pour arrêter la diffusion vers une destination, ouvrez la configuration de diffusion et cliquez sur l'icône de suppression à côté de la destination.
@@ -105,6 +131,6 @@ Pour arrêter la diffusion vers une destination, ouvrez la configuration de diff Exportez les journaux d'audit au format CSV pour l'analyse, les rapports de conformité ou l'archivage à long terme. 1. Accédez à la page [Audit log](https://app.mintlify.com/settings/organization/audit-logs) de votre dashboard. -1. Le cas échéant, appliquez des filtres pour restreindre les journaux que vous souhaitez exporter. -1. Cliquez sur **Export CSV**. -1. Mintlify vous envoie un e-mail avec un lien de téléchargement lorsque l'export est prêt. +2. Le cas échéant, appliquez des filtres pour restreindre les journaux que vous souhaitez exporter. +3. Cliquez sur **Export CSV**. +4. Mintlify vous envoie un e-mail avec un lien de téléchargement lorsque l'export est prêt. diff --git a/fr/guides/claude-code.mdx b/fr/guides/claude-code.mdx index a376e04561..a1cc17973e 100644 --- a/fr/guides/claude-code.mdx +++ b/fr/guides/claude-code.mdx @@ -30,6 +30,8 @@ Vous pouvez entraîner Claude Code à comprendre vos normes et vos flux de trava 4. Exécutez `claude` pour lancer. +Pour vérifier votre configuration, posez à Claude Code une question du type `Summarize the standards from CLAUDE.md and list the Mintlify components you can use`. Une session opérationnelle cite votre `CLAUDE.md` et fait référence à des composants Mintlify (par exemple, `Card`, `Steps` ou `Accordion`) issus du skill chargé. +
## Modèle pour CLAUDE.md
diff --git a/fr/guides/codex.mdx b/fr/guides/codex.mdx index 061d9c784f..13d94719e8 100644 --- a/fr/guides/codex.mdx +++ b/fr/guides/codex.mdx @@ -170,7 +170,7 @@ Vérifiez si cette nouvelle page respecte les normes de rédaction d'AGENTS.md e Connectez le serveur MCP de Mintlify à Codex pour lui permettre de rechercher dans la documentation Mintlify tout en vous aidant à rédiger. Lorsque vous connectez le serveur MCP, Codex peut consulter l'utilisation des composants et les options de configuration sans que vous ayez à quitter le terminal. -Ajoutez le serveur MCP à votre configuration globale Codex dans `~/.codex/config.toml` : +Ajoutez le serveur MCP à votre configuration globale Codex dans `~/.codex/config.toml`. Créez le fichier s'il n'existe pas : ```toml [mcp_servers.mintlify] @@ -184,4 +184,8 @@ Pour vous connecter au serveur MCP de votre propre site de documentation, rempla url = "https://your-docs.mintlify.site/mcp" ``` +Redémarrez votre session `codex` pour que la modification de la configuration prenne effet. Pour vérifier que le serveur MCP est connecté, demandez à Codex `Which MCP servers do you have access to?` — il doit lister l'entrée que vous venez d'ajouter. + +L'utilisation de `config.toml` enregistre le serveur MCP pour chaque session Codex sur votre machine. Le skill en session et le prompt MCP présentés plus haut chargent le même contexte à la demande dans une seule session — utilisez-les pour une exécution ponctuelle ou lorsque vous ne pouvez pas modifier `config.toml`. + Consultez [Model Context Protocol](/fr/ai/model-context-protocol) pour plus d'informations sur les serveurs MCP et savoir comment trouver le point de terminaison MCP de votre site. diff --git a/guides/claude-code.mdx b/guides/claude-code.mdx index 867d831259..56b2731edb 100644 --- a/guides/claude-code.mdx +++ b/guides/claude-code.mdx @@ -31,6 +31,8 @@ You can train Claude Code to understand your documentation standards and workflo +To confirm your setup, send a prompt to Claude Code like `List the Mintlify components you can use`. + ## Template for CLAUDE.md Save a `CLAUDE.md` file at the root of your docs directory to help Claude Code understand your project. This file trains Claude Code on your documentation standards, preferences, and workflows. See [Manage Claude's memory](https://docs.anthropic.com/en/docs/claude-code/memory) in the Anthropic docs for more information. diff --git a/guides/codex.mdx b/guides/codex.mdx index 5f4f1c34b2..c431985e91 100644 --- a/guides/codex.mdx +++ b/guides/codex.mdx @@ -166,7 +166,7 @@ Check whether this new page follows the writing standards in AGENTS.md and flag Connect the Mintlify MCP server to Codex to give it access to search the Mintlify documentation while helping you write. When you connect the MCP server, Codex can look up component usage and configuration options without you leaving the terminal. -Add the MCP server to your global Codex config at `~/.codex/config.toml`: +Add the MCP server to your global Codex config at `~/.codex/config.toml`. Create the file if it does not exist. ```toml [mcp_servers.mintlify] @@ -180,4 +180,6 @@ To connect to your own documentation site's MCP server instead, replace the URL url = "https://your-docs.mintlify.site/mcp" ``` +Restart your `codex` session for the config change to take effect. To confirm the MCP server connected, ask Codex `Which MCP servers do you have access to?`. It should list the entry you added. + See [Model Context Protocol](/ai/model-context-protocol) for more information about MCP servers and how to find your site's MCP endpoint. diff --git a/zh/agent/index.mdx b/zh/agent/index.mdx index e88dfc505c..28c94d0e70 100644 --- a/zh/agent/index.mdx +++ b/zh/agent/index.mdx @@ -16,6 +16,16 @@ agent 是一款 AI 工具，会根据你的提示，为文档创建包含建议 * **验证**：运行 Mintlify 命令行界面 (CLI) 检查，确保文档可以正确构建。 * **发布更改**：打开一个包含建议更改的拉取请求 (PR；亦称“合并请求”/Merge Request) 供你审核，或直接向你的部署 branch 提交，具体取决于你的[审核流程设置](/zh/agent/index#choose-how-the-agent-publishes-changes)。 +
+ ## 如何使用 agent +
+ +你可以通过以下方式向 agent 发送提示词： + +- **Slack**：在 agent 所在的任何频道中提及 `@Mintlify`，或直接向该应用发送私信。参见[将 agent 添加到 Slack](/zh/agent/slack)。 +- **控制台**：在 [Mintlify 控制台](https://app.mintlify.com)中打开 agent 面板以开始新对话。 +- **自动化**：按计划或基于事件触发 agent。参见[自动化](/zh/automations/index)。 +
## 你可以用智能助手做什么
diff --git a/zh/components/tree.mdx b/zh/components/tree.mdx index b0f46d82c5..7a466a7726 100644 --- a/zh/components/tree.mdx +++ b/zh/components/tree.mdx @@ -9,6 +9,8 @@ boost: 3 你可以使用 Markdown 列表或 `Tree.Folder` 与 `Tree.File` 组件来编写目录树。`` 与 `` 是别名，任一标签都可搭配任一语法使用。 +如果你需要快速、静态的目录树且每个文件夹都默认可展开，使用 Markdown 列表语法。如果你需要通过 `defaultOpen` 逐个控制文件夹的展开状态、使用 `openable` 将文件夹标记为不可交互，或在任意层级混合文件与文件夹，则使用组件语法。 +
## Markdown 列表语法
@@ -175,4 +177,6 @@ Tree 组件支持键盘导航。 在树状视图中显示的文件名。 - \ No newline at end of file + + +`Tree.File` 仅接受 `name` prop。 \ No newline at end of file diff --git a/zh/create/text.mdx b/zh/create/text.mdx index 1609193aca..85f957636a 100644 --- a/zh/create/text.mdx +++ b/zh/create/text.mdx @@ -42,6 +42,19 @@ keywords: ["Markdown 格式", "文本样式", "标题", "锚点链接", "custom 当一个页面中的多个标题生成相同的 ID 时，Mintlify 会依次添加 `-2`、`-3` 等后缀。该计数器在整个页面范围内生效，包括嵌套在选项卡等组件中的标题。 +以下示例展示了标题文本如何映射为生成的锚点 ID： + +| 标题文本 | 生成的 ID | +| :--- | :--- | +| `Getting started` | `getting-started` | +| `Config.json options` | `config-json-options` | +| `What's new` | `what’s-new` | +| `Rate limits (per minute)` | `rate-limits-per-minute` | +| `Read/write access` | `read/write-access` | +| `Fees & billing` | `fees-&-billing` | +| `OAuth` | `oauth` | +| 重复的 `Overview` 标题 | `overview-2` | + Mintlify 的锚点 ID 不使用 GitHub 风格的 slug。以编程方式构造 URL 时，请对非 ASCII 字符进行百分号编码。 diff --git a/zh/dashboard/audit-logs.mdx b/zh/dashboard/audit-logs.mdx index e6e2e0ba51..722855c721 100644 --- a/zh/dashboard/audit-logs.mdx +++ b/zh/dashboard/audit-logs.mdx @@ -87,6 +87,32 @@ keywords: ["监控", "活动追踪", "安全", "合规"] 5. 点击 **Add destination**。 + + + 创建一个 IAM 用户（或具有编程访问凭证的角色），其策略允许写入目标 bucket。至少要为你计划使用的 bucket 和 key 前缀授予 `s3:PutObject` 权限。例如： + + ```json + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": ["s3:PutObject"], + "Resource": "arn:aws:s3:::your-bucket-name/audit-logs/*" + } + ] + } + ``` + + 在添加目标时，请使用该 IAM 用户的 access key ID 和 secret access key。key 前缀是可选的，会作为前缀添加到 Mintlify 写入的每个对象。 + + + 在 Datadog 账户的 **Organization Settings > API Keys** 中创建一个 Datadog API key。请勿使用 application key。 + + 将 Datadog 站点设置为与你的 Datadog 账户所在区域相匹配，例如 `datadoghq.com`（US1）、`us3.datadoghq.com`、`us5.datadoghq.com`、`datadoghq.eu`（EU1）、`ap1.datadoghq.com` 或 `ddog-gov.com`。使用错误的站点将导致事件被拒绝。 + + + 要停止向某个目标进行流式传输，打开流式传输配置，然后点击该目标旁边的 移除图标。
@@ -105,6 +131,6 @@ keywords: ["监控", "活动追踪", "安全", "合规"] 将审计日志导出为 CSV，用于分析、合规报告或长期归档。 1. 前往 dashboard 的 [Audit log](https://app.mintlify.com/settings/organization/audit-logs) 页面。 -1. （可选）应用筛选条件以缩小要导出的日志范围。 -1. 点击 **Export CSV**。 -1. 当导出完成后，Mintlify 会向你发送一封包含下载链接的电子邮件。 +2. （可选）应用筛选条件以缩小要导出的日志范围。 +3. 点击 **Export CSV**。 +4. 当导出完成后，Mintlify 会向你发送一封包含下载链接的电子邮件。 diff --git a/zh/guides/claude-code.mdx b/zh/guides/claude-code.mdx index e64d57fee8..5bcbda657d 100644 --- a/zh/guides/claude-code.mdx +++ b/zh/guides/claude-code.mdx @@ -29,6 +29,7 @@ Claude Code 是一款具备智能体能力的命令行工具，能帮助你维 3. （可选）将下面的 `CLAUDE.md` 文件添加到您的项目中。 4. 运行 `claude` 启动。 +要确认你的设置是否正常，可向 Claude Code 提问，例如 `Summarize the standards from CLAUDE.md and list the Mintlify components you can use`。正常运行的会话会引用你的 `CLAUDE.md`，并从已加载的 skill 中引用 Mintlify 组件（例如 `Card`、`Steps` 或 `Accordion`）。
## CLAUDE.md 的模板 diff --git a/zh/guides/codex.mdx b/zh/guides/codex.mdx index 2bc703cfa3..dfd94328b8 100644 --- a/zh/guides/codex.mdx +++ b/zh/guides/codex.mdx @@ -170,7 +170,7 @@ Before finishing any documentation task: 将 Mintlify MCP 服务器连接到 Codex，使其在帮助你写作时可以搜索 Mintlify 文档。连接 MCP 服务器后，Codex 可以查阅组件用法和配置选项，无需离开终端。 -将 MCP 服务器添加到位于 `~/.codex/config.toml` 的全局 Codex 配置中： +将 MCP 服务器添加到位于 `~/.codex/config.toml` 的全局 Codex 配置中。如果该文件不存在，请先创建： ```toml [mcp_servers.mintlify] @@ -184,4 +184,8 @@ url = "https://mintlify.com/docs/mcp" url = "https://your-docs.mintlify.site/mcp" ``` +重启你的 `codex` 会话以使配置更改生效。要确认 MCP 服务器已连接，可向 Codex 提问 `Which MCP servers do you have access to?`——它应列出你刚才添加的条目。 + +使用 `config.toml` 会为你计算机上的每个 Codex 会话注册该 MCP 服务器。前面展示的会话内 skill 和 MCP 提示则可以在单个会话中按需加载相同的 context——当你需要一次性运行或无法编辑 `config.toml` 时，请使用该方式。 + 有关 MCP 服务器以及如何查找你站点 MCP 端点的更多信息，请参阅 [Model Context Protocol](/zh/ai/model-context-protocol)。