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.
Si tu sitio requiere autenticación para acceder a tu documentación, tus archivos
llms.txt y llms-full.txt no están disponibles para los LLM y las herramientas de IA. Los LLM y las herramientas de IA solo pueden indexar contenido que sea accesible públicamente.llms.txt añadiendo /llms.txt a la URL de tu sitio de documentación.
Abrir el llms.txt de este sitio.
Estructura de llms.txt
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.
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.
Example llms.txt
llms-full.txt
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.
Abrir el llms-full.txt de este sitio.
Archivos personalizados
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 en la especificación de llms.txt para obtener más información sobre secciones opcionales y buenas prácticas.