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
4 changes: 4 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"]
boost: 3
---
Expand All @@ -12,24 +12,24 @@
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>
Authentication affects `llms.txt` and `llms-full.txt` differently depending on your site configuration:

Check warning on line 15 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L15

Use 'LLMs?' instead of 'llms'.

- **Fully authenticated sites**: Both files require authentication. AI tools that cannot authenticate cannot access them.
- **Partially authenticated sites**: Both files are publicly accessible, but only list public pages. Pages restricted to user groups are excluded.

Check warning on line 18 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L18

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

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 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'.

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 29 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L29

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 32 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L32

Use 'LLMs?' instead of 'llms'.

Check warning on line 32 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L32

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

An `llms.txt` file is a plain Markdown file that contains:

Expand All @@ -44,6 +44,10 @@

This structured approach allows LLMs to efficiently process your documentation at a high level and locate relevant content for user queries, improving the accuracy and speed of AI-assisted documentation searches.

<Note>
Automatically generated `llms.txt` files cannot exceed 100,000 characters. If your documentation exceeds this limit, Mintlify truncates the file and appends a note listing the number of omitted pages. To list every page without truncation, add a [custom `llms.txt` file](#custom-files) at the root of your project.
</Note>

```mdx Example llms.txt
# Site title

Expand All @@ -70,7 +74,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 77 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L77

Use 'LLMs?' instead of 'llms'.

## Custom files

Expand Down
4 changes: 4 additions & 0 deletions es/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ La descripción de cada página proviene del campo `description` en su frontmatt

Este enfoque estructurado permite a los LLM procesar tu documentación de forma eficiente a un alto nivel y localizar contenido relevante para las consultas de los usuarios, mejorando la precisión y la velocidad de las búsquedas de documentación asistidas por IA.

<Note>
El archivo `llms.txt` generado automáticamente está limitado a 100.000 caracteres. Si tu documentación supera este límite, Mintlify trunca el archivo y añade una nota indicando el número de páginas omitidas. Para listar todas las páginas sin truncamiento, añade un [archivo `llms.txt` personalizado](#custom-files) en la raíz de tu proyecto.
</Note>

```mdx Example llms.txt
# Título del sitio

Expand Down
4 changes: 4 additions & 0 deletions fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ La description de chaque page provient du champ `description` de son frontmatter

Cette approche structurée permet aux LLMs de traiter efficacement votre documentation à un niveau global et de repérer le contenu pertinent pour les requêtes des utilisateurs, améliorant ainsi la précision et la rapidité des recherches documentaires assistées par l'IA.

<Note>
Le fichier `llms.txt` généré automatiquement est limité à 100 000 caractères. Si votre documentation dépasse cette limite, Mintlify tronque le fichier et ajoute une note indiquant le nombre de pages omises. Pour lister toutes les pages sans troncature, ajoutez un [fichier `llms.txt` personnalisé](#custom-files) à la racine de votre projet.
</Note>

```mdx Example llms.txt
# Titre du site

Expand Down
4 changes: 4 additions & 0 deletions zh/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ Mintlify 会在每个页面的响应中添加 HTTP 标头,以便 AI 工具无

这种结构化方法使 LLM 能够高效地从宏观层面处理你的文档,并为用户查询定位相关内容,从而提升 AI 辅助文档搜索的准确性和速度。

<Note>
自动生成的 `llms.txt` 文件上限为 100,000 个字符。如果你的文档超过此限制,Mintlify 会截断该文件,并附加一条说明列出被省略的页面数量。若要不经截断列出所有页面,请在项目根目录添加一个[自定义 `llms.txt` 文件](#custom-files)。
</Note>

```mdx Example llms.txt
# 站点标题

Expand Down
Loading