Skip to content
Closed
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: 2 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 to help AI tools 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,14 +11,14 @@
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.
</Note>

View your `llms.txt` by appending `/llms.txt` to your documentation site's URL.

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

Check warning on line 19 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L19

Use 'LLMs?' instead of 'llms'.

## llms.txt structure

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

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

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

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

Expand All @@ -30,6 +30,8 @@

Each page's description comes from the `description` field in its frontmatter. For API reference pages, the description also includes the specification information from the `openapi` or `api` frontmatter field. Pages without a `description` field appear in the `llms.txt` file without a description.

Descriptions are truncated to 300 characters. If a description has multiple paragraphs, only the first paragraph is included. Longer descriptions are cut off with an ellipsis (…).

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

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

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

In general, use active voice instead of passive voice ('is included').

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

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

```mdx Example llms.txt
# Site title

Expand All @@ -53,7 +55,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 58 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L58

Use 'LLMs?' instead of 'llms'.

## Custom files

Expand Down
2 changes: 1 addition & 1 deletion es/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ El archivo `llms.txt` lista tus páginas alfabéticamente en el orden en que apa

La descripción de cada página proviene del campo `description` en su frontmatter. Para las páginas de referencia de API, la descripción también incluye la información de la especificación del campo `openapi` o `api` del frontmatter. Las páginas sin el campo `description` aparecen en el archivo `llms.txt` sin descripción.

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.
Las descripciones se truncan a 300 caracteres. Si una descripción tiene varios párrafos, solo se incluye el primero. Las descripciones más largas se cortan con puntos suspensivos (…).

```mdx Example llms.txt
# Título del sitio
Expand Down
2 changes: 2 additions & 0 deletions fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Le fichier `llms.txt` répertorie vos pages par ordre alphabétique selon leur e

La description de chaque page provient du champ `description` de son frontmatter. Pour les pages de référence d&#39;API, la description inclut également les informations de spécification issues du champ de frontmatter `openapi` ou `api`. Les pages sans champ `description` apparaissent dans le fichier `llms.txt` sans description.

Les descriptions sont tronquées à 300 caractères. Si une description comporte plusieurs paragraphes, seul le premier est inclus. Les descriptions plus longues sont coupées avec des points de suspension (…).

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

Expand Down
2 changes: 2 additions & 0 deletions zh/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件,列出文

每个页面的说明来自其 frontmatter 中的 `description` 字段。对于 API 参考页面,说明中还会包含来自 `openapi` 或 `api` frontmatter 字段的规范信息。没有 `description` 字段的页面将在 `llms.txt` 中显示,但不含说明。

说明内容将被截断至 300 个字符。如果说明包含多个段落,则仅保留第一段。超出长度的说明将以省略号 (…) 结尾。

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

Expand Down
Loading