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
3 changes: 3 additions & 0 deletions ai/llmstxt.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "llms.txt"
description: "Automatically generate llms.txt and llms-full.txt files so AI tools like ChatGPT and Claude can index and understand your documentation."

Check warning on line 3 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L3

Use 'LLMs?' instead of 'llms'.
keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"]
---

Expand All @@ -11,25 +11,26 @@
Mintlify automatically hosts an `llms.txt` file at the root of your project that lists all available pages in your documentation. This file is always up to date and requires zero maintenance. You can optionally add a custom `llms.txt` file to the root of your project.

<Note>
If your site requires authentication, `llms.txt` and `llms-full.txt` also require authentication to view. LLMs and AI tools that cannot authenticate into your site cannot access these files. The files exclude pages that belong to [user groups](/deploy/authentication-setup#control-access-with-groups).

Check warning on line 14 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L14

Use 'LLMs?' instead of 'llms'.

Check warning on line 14 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L14

'llms-full.txt' should use sentence-style capitalization.

For more information on how authentication affects AI features, see [Feature availability](/deploy/authentication-setup#feature-availability).
</Note>

View your `llms.txt` by appending `/llms.txt` to your documentation site's URL. Mintlify also hosts the file at `/.well-known/llms.txt` for compatibility with tools that follow the `.well-known` convention.

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

Check warning on line 21 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L21

Use 'LLMs?' instead of 'llms'.

Mintlify adds HTTP headers to every page response so AI tools can discover your `llms.txt` files without prior knowledge of their location:

- `Link: </llms.txt>; rel="llms-txt", </llms-full.txt>; rel="llms-full-txt"`: Follows the standard HTTP `Link` header format for resource discovery.

Check warning on line 25 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L25

Use 'LLMs?' instead of 'llms'.
- `X-Llms-Txt: /llms.txt`: A convenience header for tools that check for `llms.txt` support.

## llms.txt structure

Check warning on line 28 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L28

Use 'LLMs?' instead of 'llms'.

Check warning on line 28 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L28

'llms.txt structure' should use sentence-style capitalization.

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.

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 'Blockquotes?' instead of 'blockquote'.
- **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.

Expand All @@ -42,6 +43,8 @@
```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
Expand All @@ -63,7 +66,7 @@

Mintlify automatically hosts an `llms-full.txt` file at the root of your project. View your `llms-full.txt` by appending `/llms-full.txt` to your documentation site's URL. Mintlify also hosts the file at `/.well-known/llms-full.txt` for compatibility with tools that follow the `.well-known` convention.

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

Check warning on line 69 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L69

Use 'LLMs?' instead of 'llms'.

## Custom files

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

Expand All @@ -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
Expand Down
3 changes: 3 additions & 0 deletions fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Expand Down
3 changes: 3 additions & 0 deletions zh/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Mintlify 会在每个页面的响应中添加 HTTP 标头,以便 AI 工具无
`llms.txt` 文件是一个纯 Markdown 文件,包含:

* 以 H1 标题形式呈现的**站点标题**。
* **站点描述**,以引用块形式显示在标题下方,来源于 `docs.json` 配置中的 `description` 字段。
* **结构化内容部分**,包含链接以及文档中每个页面的说明。
* 指向 OpenAPI 和 AsyncAPI 规范的 **API 规范链接** (如果文档中包含这些规范) 。

Expand All @@ -44,6 +45,8 @@ Mintlify 会在每个页面的响应中添加 HTTP 标头,以便 AI 工具无
```mdx Example llms.txt
# 站点标题

> 文档站点的简要描述。

## 文档

- [API](https://example.com/docs/api.md): 端点列表和使用方法
Expand Down
Loading