From 2f5dbe0dc5810969a9af2510d8e18594e5429fc8 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 10 Apr 2026 00:11:38 +0000 Subject: [PATCH] Document blockquote description in llms.txt structure Generated-By: mintlify-agent --- ai/llmstxt.mdx | 3 +++ es/ai/llmstxt.mdx | 3 +++ fr/ai/llmstxt.mdx | 3 +++ zh/ai/llmstxt.mdx | 3 +++ 4 files changed, 12 insertions(+) diff --git a/ai/llmstxt.mdx b/ai/llmstxt.mdx index 9237ca7b6..9d29fb2b9 100644 --- a/ai/llmstxt.mdx +++ b/ai/llmstxt.mdx @@ -30,6 +30,7 @@ Mintlify adds HTTP headers to every page response so AI tools can discover your An `llms.txt` file is a plain Markdown file that contains: - **Site title** as an H1 heading. +- **Site description** as a blockquote summary below the title, sourced from the `description` field in your `docs.json` configuration. - **Structured content sections** with links and a description of each page in your documentation. - **API specification links** to your OpenAPI and AsyncAPI specs, if your documentation includes them. @@ -42,6 +43,8 @@ This structured approach allows LLMs to efficiently process your documentation a ```mdx Example llms.txt # Site title +> A brief description of the documentation site. + ## Docs - [API](https://example.com/docs/api.md): Endpoint list and usage diff --git a/es/ai/llmstxt.mdx b/es/ai/llmstxt.mdx index b7bdf9557..b69adbfc3 100644 --- a/es/ai/llmstxt.mdx +++ b/es/ai/llmstxt.mdx @@ -32,6 +32,7 @@ Mintlify añade encabezados HTTP a cada respuesta de página para que las herram Un archivo `llms.txt` es un archivo Markdown sin formato que contiene: * **Título del sitio** como encabezado H1. +* **Descripción del sitio** como una cita debajo del título, obtenida del campo `description` en tu configuración `docs.json`. * **Secciones de contenido estructuradas** con enlaces y una descripción de cada página de tu documentación. * **Enlaces a especificaciones de API** a tus especificaciones OpenAPI y AsyncAPI, si tu documentación las incluye. @@ -44,6 +45,8 @@ Este enfoque estructurado permite a los LLM procesar tu documentación de forma ```mdx Example llms.txt # Título del sitio +> Una breve descripción del sitio de documentación. + ## Documentación - [API](https://example.com/docs/api.md): Lista de endpoints y uso diff --git a/fr/ai/llmstxt.mdx b/fr/ai/llmstxt.mdx index ae6f2723b..743f90706 100644 --- a/fr/ai/llmstxt.mdx +++ b/fr/ai/llmstxt.mdx @@ -32,6 +32,7 @@ Mintlify ajoute des en-têtes HTTP à chaque réponse de page afin que les outil Un fichier `llms.txt` est un simple fichier Markdown qui contient : * **Le titre du site** en tant que H1. +* **La description du site** sous forme de citation en dessous du titre, provenant du champ `description` de votre configuration `docs.json`. * **Des sections de contenu structurées** avec des liens et une description de chaque page de votre documentation. * **Des liens vers les spécifications d'API** pointant vers vos spécifications OpenAPI et AsyncAPI, si votre documentation en inclut. @@ -44,6 +45,8 @@ Cette approche structurée permet aux LLMs de traiter efficacement votre documen ```mdx Example llms.txt # Titre du site +> Une brève description du site de documentation. + ## Documentation - [API](https://example.com/docs/api.md) : Liste des endpoints et utilisation diff --git a/zh/ai/llmstxt.mdx b/zh/ai/llmstxt.mdx index 92d400bd9..a71df418b 100644 --- a/zh/ai/llmstxt.mdx +++ b/zh/ai/llmstxt.mdx @@ -32,6 +32,7 @@ Mintlify 会在每个页面的响应中添加 HTTP 标头，以便 AI 工具无 `llms.txt` 文件是一个纯 Markdown 文件，包含： * 以 H1 标题形式呈现的**站点标题**。 +* **站点描述**，以引用块形式显示在标题下方，来源于 `docs.json` 配置中的 `description` 字段。 * **结构化内容部分**，包含链接以及文档中每个页面的说明。 * 指向 OpenAPI 和 AsyncAPI 规范的 **API 规范链接** (如果文档中包含这些规范) 。 @@ -44,6 +45,8 @@ Mintlify 会在每个页面的响应中添加 HTTP 标头，以便 AI 工具无 ```mdx Example llms.txt # 站点标题 +> 文档站点的简要描述。 + ## 文档 - [API](https://example.com/docs/api.md): 端点列表和使用方法