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
2 changes: 1 addition & 1 deletion ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@

<PreviewButton href="https://mintlify.com/docs/llms.txt">Open the llms.txt for this site.</PreviewButton>

Mintlify adds HTTP headers to every page response so AI tools can discover your `llms.txt` files and other agent resources without prior knowledge of their location:
Mintlify adds HTTP headers to every response, including [Markdown responses](/ai/markdown-export) and 404 pages, so AI tools can discover your `llms.txt` files and other agent resources without prior knowledge of their location:

- `Link`: Follows the standard HTTP `Link` header format for resource discovery. Advertises `llms.txt`, `llms-full.txt`, your API catalog, [MCP server card](/ai/model-context-protocol#discovery-endpoint), [agent card](/ai/skillmd#agent-card), and [agent skills index](/ai/skillmd#skills-discovery-endpoints).
- `X-Llms-Txt`: A convenience header for tools that check for `llms.txt` support.

```http Response headers
Link: </llms.txt>; rel="llms-txt", </llms-full.txt>; rel="llms-full-txt", </.well-known/api-catalog>; rel="api-catalog", </.well-known/mcp/server-card.json>; rel="mcp-server-card", </.well-known/agent-card.json>; rel="agent-card", </.well-known/agent-skills/index.json>; rel="agent-skills"

Check warning on line 33 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L33

Use 'API' instead of 'api'.
X-Llms-Txt: /llms.txt
```

Expand Down Expand Up @@ -69,14 +69,14 @@
- [API reference (250 pages)](https://docs.example.com/_llms/api-reference.md): Endpoint documentation for the example API
```

A generated index can link to further indexes. For example, `/_llms/api-reference.md` can link to `/_llms/api-reference/admin.md` when a group is too large for a single file. Agents should follow these index links recursively until they reach documentation page links. Mintlify may shorten page descriptions in a split index to keep each file under the character limit.

Check warning on line 72 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L72

Use 'API' instead of 'api'.

The generated files are part of `llms.txt` and do not need to exist in your repository. They are separate from `llms-full.txt`.

The `/_llms/` route uses the same base path as your documentation:

- A root-hosted site serves an index at `https://docs.example.com/_llms/api-reference.md`.
- A site hosted at `/docs` serves it at `https://example.com/docs/_llms/api-reference.md`.

Check warning on line 79 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L79

Use 'API' instead of 'api'.

If you use a reverse proxy or path allowlist, forward the generated route in addition to `llms.txt`. A broad `<base-path>/*` rule already includes `<base-path>/_llms/*`. With granular rules, add `<base-path>/_llms/*` explicitly. See [Reverse proxy](/deploy/reverse-proxy#routing-configuration) for routing guidance.

Expand Down
21 changes: 21 additions & 0 deletions ai/markdown-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,27 @@ Send a request with `Accept: text/markdown` or `Accept: text/plain` to any page
curl -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export
```

## Missing pages

If you request a page that doesn't exist as Markdown, Mintlify returns a 404 status with a Markdown body that helps AI tools recover. The response links to your documentation index (`llms.txt`), your full documentation file (`llms-full.txt`), and up to three related pages based on the requested path.

```md Example Markdown 404 response
> ## Documentation Index
> Fetch the documentation index at: https://example.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For broader context, fetch the full documentation at: https://example.com/docs/llms-full.txt (large file).

# Page Not Found

The requested page could not be found.

## Related topics

- [Getting started](https://example.com/docs/getting-started.md)
```

Related page suggestions come from the same search that powers your site's [404 page](/customize/custom-404-page). Sites that use [authentication](/deploy/authentication-setup) omit suggestions and return only the documentation links.

## Audience-specific content

Use the [visibility](/components/visibility) component to customize content for human and AI audiences.
Expand Down
2 changes: 1 addition & 1 deletion es/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Consulta tu `llms.txt` añadiendo `/llms.txt` a la URL de tu sitio de documentac

<PreviewButton href="https://mintlify.com/docs/llms.txt">Abrir el llms.txt de este sitio.</PreviewButton>

Mintlify añade encabezados HTTP a cada respuesta de página para que las herramientas de IA puedan descubrir tus archivos `llms.txt` y otros recursos para agentes sin conocer previamente su ubicación:
Mintlify añade encabezados HTTP a cada respuesta, incluidas las [respuestas Markdown](/es/ai/markdown-export) y las páginas 404, para que las herramientas de IA puedan descubrir tus archivos `llms.txt` y otros recursos para agentes sin conocer previamente su ubicación:

- `Link`: Sigue el formato estándar del encabezado HTTP `Link` para el descubrimiento de recursos. Anuncia `llms.txt`, `llms-full.txt`, tu catálogo de API, [tarjeta del servidor MCP](/es/ai/model-context-protocol#discovery-endpoint), [tarjeta del agente](/es/ai/skillmd#agent-card) e [índice de skills del agente](/es/ai/skillmd#skills-discovery-endpoints).
- `X-Llms-Txt`: Un encabezado de conveniencia para herramientas que verifican la compatibilidad con `llms.txt`.
Expand Down
23 changes: 23 additions & 0 deletions es/ai/markdown-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,29 @@ Envía una solicitud con `Accept: text/markdown` o `Accept: text/plain` a la URL
curl -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export
```

<div id="missing-pages">
## Páginas inexistentes
</div>

Si solicitas en Markdown una página que no existe, Mintlify devuelve un estado 404 con un cuerpo Markdown que ayuda a las herramientas de IA a recuperarse. La respuesta enlaza al índice de tu documentación (`llms.txt`), a tu archivo de documentación completa (`llms-full.txt`) y hasta a tres páginas relacionadas según la ruta solicitada.

```md Example Markdown 404 response
> ## Documentation Index
> Fetch the documentation index at: https://example.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For broader context, fetch the full documentation at: https://example.com/docs/llms-full.txt (large file).

# Page Not Found

The requested page could not be found.

## Related topics

- [Getting started](https://example.com/docs/getting-started.md)
```

Las sugerencias de páginas relacionadas provienen de la misma búsqueda que impulsa la [página 404](/es/customize/custom-404-page) de tu sitio. Los sitios que usan [autenticación](/es/deploy/authentication-setup) omiten las sugerencias y devuelven solo los enlaces de documentación.

<div id="audience-specific-content">
## Contenido específico por audiencia
</div>
Expand Down
2 changes: 1 addition & 1 deletion fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Affichez votre `llms.txt` en ajoutant `/llms.txt` à l'URL de votre site de docu

<PreviewButton href="https://mintlify.com/docs/llms.txt">Ouvrir le llms.txt de ce site.</PreviewButton>

Mintlify ajoute des en-têtes HTTP à chaque réponse de page afin que les outils d'IA puissent découvrir vos fichiers `llms.txt` et autres ressources d'agent sans connaître au préalable leur emplacement :
Mintlify ajoute des en-têtes HTTP à chaque réponse, y compris les [réponses Markdown](/fr/ai/markdown-export) et les pages 404, afin que les outils d'IA puissent découvrir vos fichiers `llms.txt` et autres ressources d'agent sans connaître au préalable leur emplacement :

- `Link` : Suit le format standard de l'en-tête HTTP `Link` pour la découverte de ressources. Annonce `llms.txt`, `llms-full.txt`, votre catalogue d'API, la [carte du serveur MCP](/fr/ai/model-context-protocol#discovery-endpoint), l'[agent card](/fr/ai/skillmd#agent-card) et l'[index des agent skills](/fr/ai/skillmd#skills-discovery-endpoints).
- `X-Llms-Txt` : Un en-tête pratique pour les outils qui vérifient la prise en charge de `llms.txt`.
Expand Down
23 changes: 23 additions & 0 deletions fr/ai/markdown-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,29 @@ Envoyez une requête avec `Accept: text/markdown` ou `Accept: text/plain` à l'U
curl -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export
```

<div id="missing-pages">
## Pages introuvables
</div>

Si vous demandez en Markdown une page qui n'existe pas, Mintlify renvoie un statut 404 avec un corps Markdown qui aide les outils d'IA à se rétablir. La réponse renvoie vers l'index de votre documentation (`llms.txt`), votre fichier de documentation complète (`llms-full.txt`) et jusqu'à trois pages associées selon le chemin demandé.

```md Example Markdown 404 response
> ## Documentation Index
> Fetch the documentation index at: https://example.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For broader context, fetch the full documentation at: https://example.com/docs/llms-full.txt (large file).

# Page Not Found

The requested page could not be found.

## Related topics

- [Getting started](https://example.com/docs/getting-started.md)
```

Les suggestions de pages associées proviennent de la même recherche que celle de la [page 404](/fr/customize/custom-404-page) de votre site. Les sites qui utilisent l'[authentification](/fr/deploy/authentication-setup) omettent les suggestions et ne renvoient que les liens de documentation.

<div id="audience-specific-content">
## Contenu spécifique par audience
</div>
Expand Down
2 changes: 1 addition & 1 deletion zh/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件,列出文

<PreviewButton href="https://mintlify.com/docs/llms.txt">打开此站点的 llms.txt。</PreviewButton>

Mintlify 会在每个页面的响应中添加 HTTP 标头,以便 AI 工具无需事先知道位置即可发现你的 `llms.txt` 文件以及其他代理资源:
Mintlify 会在每个响应中添加 HTTP 标头,包括 [Markdown 响应](/zh/ai/markdown-export)和 404 页面,以便 AI 工具无需事先知道位置即可发现你的 `llms.txt` 文件以及其他代理资源:

- `Link`:遵循标准 HTTP `Link` 标头格式,用于资源发现。会公布 `llms.txt`、`llms-full.txt`、你的 API 目录、[MCP 服务器卡片](/zh/ai/model-context-protocol#discovery-endpoint)、[代理卡片](/zh/ai/skillmd#agent-card)以及[代理技能索引](/zh/ai/skillmd#skills-discovery-endpoints)。
- `X-Llms-Txt`:一个便捷标头,供检查 `llms.txt` 支持情况的工具使用。
Expand Down
23 changes: 23 additions & 0 deletions zh/ai/markdown-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,29 @@ Mintlify 会自动生成针对 AI 工具和外部 integrations 优化的页面 M
curl -L -H "Accept: text/markdown" https://mintlify.com/docs/ai/markdown-export
```

<div id="missing-pages">
## 不存在的页面
</div>

如果你以 Markdown 形式请求一个不存在的页面,Mintlify 会返回 404 状态码以及一个帮助 AI 工具恢复的 Markdown 响应体。该响应包含指向文档索引(`llms.txt`)、完整文档文件(`llms-full.txt`)的链接,以及根据请求路径推荐的最多三个相关页面。

```md Example Markdown 404 response
> ## Documentation Index
> Fetch the documentation index at: https://example.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
> For broader context, fetch the full documentation at: https://example.com/docs/llms-full.txt (large file).

# Page Not Found

The requested page could not be found.

## Related topics

- [Getting started](https://example.com/docs/getting-started.md)
```

相关页面建议来自为你站点 [404 页面](/zh/customize/custom-404-page)提供支持的同一搜索。使用[身份验证](/zh/deploy/authentication-setup)的站点会省略建议,仅返回文档链接。

<div id="audience-specific-content">
## 面向特定受众的内容
</div>
Expand Down