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: 1 addition & 1 deletion ai/llmstxt.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "llms.txt"
description: "Optimize your docs for LLMs to read and index."
keywords: ["llms.txt", "LLM indexing", "AEO", "GEO", "content discovery"]

Check warning on line 4 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L4

Use 'LLMs' instead of 'llms'.
---

import { PreviewButton } from "/snippets/previewbutton.jsx"
Expand All @@ -16,18 +16,18 @@

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:

- **Site title** as an H1 heading.
- **Structured content sections** with links and a description of each page in your documentation.

Pages are listed alphabetically in the order they appear in your repository, starting from the root directory.

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

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

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

```mdx Example llms.txt
# Site title
Expand All @@ -41,16 +41,16 @@

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.

## llms-full.txt

Check warning on line 44 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L44

Use 'LLMs' instead of 'llms'.

Check warning on line 44 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L44

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

The `llms-full.txt` file combines your entire documentation site into a single file as context for AI tools and is indexed by LLM traffic.

Check warning on line 46 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L46

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

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.

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

Check warning on line 50 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L50

Use 'LLMs' instead of 'llms'.

## Custom files

To add a custom `llms.txt` or `llms-full.txt` file, create an `llms.txt` or `llms-full.txt` file at the root of your project. Adding a custom file will override the automatically generated file of the same name. If you delete a custom file, the default file will be used again.

Check warning on line 54 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L54

Avoid using 'will'.

Check warning on line 54 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L54

Avoid using 'will'.

Check warning on line 54 in ai/llmstxt.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/llmstxt.mdx#L54

In general, use active voice instead of passive voice ('be used').

Your custom `llms.txt` or `llms-full.txt` file must have a site title as an H1 heading. Other content is optional. See [Format](https://llmstxt.org/#format) in the `llms.txt` specification for more information on optional sections and best practices.
2 changes: 1 addition & 1 deletion es/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Un archivo `llms.txt` es un archivo Markdown sin formato que contiene:

Las páginas se listan alfabéticamente en el orden en que aparecen en tu repositorio, comenzando desde el directorio raíz.

La descripción de cada página proviene del campo `description` en su frontmatter. Las páginas sin el campo `description` aparecen en el archivo `llms.txt` sin descripción.
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 OpenAPI del campo `openapi` o `api` del frontmatter. Las páginas sin el campo `description` aparecen en el archivo `llms.txt` sin descripción.

```mdx Example llms.txt
# Título del sitio
Expand Down
2 changes: 1 addition & 1 deletion fr/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Un fichier `llms.txt` est un simple fichier Markdown qui contient :

Les pages sont classées par ordre alphabétique selon leur emplacement dans votre référentiel, en commençant au répertoire racine.

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

```mdx Example llms.txt
# Titre du site
Expand Down
2 changes: 1 addition & 1 deletion zh/ai/llmstxt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件,列出文

页面按在存储库中的位置以字母顺序列出,从根目录开始。

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

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