mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
9d82233e1c
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
70 lines
4.5 KiB
Plaintext
70 lines
4.5 KiB
Plaintext
---
|
|
title: "llms.txt"
|
|
description: "Genera automáticamente archivos llms.txt y llms-full.txt para ayudar a las herramientas de IA a indexar y comprender tu documentación."
|
|
keywords: ["llms.txt", "indexación de LLM", "AEO", "GEO", "descubrimiento de contenido"]
|
|
---
|
|
|
|
import { PreviewButton } from "/snippets/previewbutton.jsx"
|
|
|
|
El [archivo llms.txt](https://llmstxt.org) es un estándar del sector que ayuda a los LLM a indexar contenido de forma más eficiente, de manera similar a como un sitemap ayuda a los motores de búsqueda. Las herramientas de IA pueden usar este archivo para entender la estructura de tu documentación y encontrar contenido relevante para las consultas de los usuarios.
|
|
|
|
Mintlify aloja automáticamente un archivo `llms.txt` en la raíz de tu proyecto que lista todas las páginas disponibles de tu documentación. Este archivo siempre está actualizado y no requiere mantenimiento. Opcionalmente, puedes añadir un `llms.txt` personalizado en la raíz de tu proyecto.
|
|
|
|
<Note>
|
|
Si tu sitio requiere autenticación, `llms.txt` y `llms-full.txt` también requieren autenticación para poder verse. Los LLM y las herramientas de IA que no puedan autenticarse en tu sitio no pueden acceder a estos archivos. Los archivos excluyen las páginas que pertenecen a [grupos de usuarios](/es/deploy/authentication-setup#control-access-with-groups).
|
|
</Note>
|
|
|
|
Consulta tu `llms.txt` añadiendo `/llms.txt` a la URL de tu sitio de documentación.
|
|
|
|
<PreviewButton href="https://mintlify.com/docs/llms.txt">Abrir el llms.txt de este sitio.</PreviewButton>
|
|
|
|
<div id="llmstxt-structure">
|
|
## Estructura de llms.txt
|
|
</div>
|
|
|
|
Un archivo `llms.txt` es un archivo Markdown sin formato que contiene:
|
|
|
|
* **Título del sitio** como encabezado H1.
|
|
* **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.
|
|
|
|
El archivo `llms.txt` lista tus páginas 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. 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.
|
|
|
|
```mdx Example llms.txt
|
|
# Título del sitio
|
|
|
|
## Documentación
|
|
|
|
- [API](https://example.com/docs/api): Lista de endpoints y uso
|
|
- [Instalar](https://example.com/docs/install): Pasos de configuración
|
|
- [Primeros pasos](https://example.com/docs/start): Guía de introducción
|
|
|
|
## Especificaciones de API
|
|
|
|
- [openapi](https://example.com/docs/openapi.json)
|
|
- [asyncapi](https://example.com/docs/asyncapi.yaml)
|
|
```
|
|
|
|
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.
|
|
|
|
<div id="llms-fulltxt">
|
|
## llms-full.txt
|
|
</div>
|
|
|
|
El archivo `llms-full.txt` reúne todo tu sitio de documentación en un único archivo como contexto para herramientas de IA y la indexación de los LLM.
|
|
|
|
Mintlify aloja automáticamente un archivo `llms-full.txt` en la raíz de tu proyecto. Visualiza tu `llms-full.txt` agregando `/llms-full.txt` a la URL de tu sitio de documentación.
|
|
|
|
<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Abrir el llms-full.txt de este sitio.</PreviewButton>
|
|
|
|
<div id="custom-files">
|
|
## Archivos personalizados
|
|
</div>
|
|
|
|
Para agregar un archivo personalizado `llms.txt` o `llms-full.txt`, crea un archivo `llms.txt` o `llms-full.txt` en la raíz de tu proyecto. Agregar un archivo personalizado reemplazará el archivo generado automáticamente con el mismo nombre. Si eliminas un archivo personalizado, Mintlify restaura el archivo generado automáticamente.
|
|
|
|
Tu archivo personalizado `llms.txt` o `llms-full.txt` debe incluir el título del sitio como encabezado H1. El resto del contenido es opcional. Consulta [Format](https://llmstxt.org/#format) en la especificación de `llms.txt` para obtener más información sobre secciones opcionales y buenas prácticas. |