llms.txt para LLMs
llms.txt es un estándar para publicar documentación en texto plano pensada para modelos de lenguaje: un índice que resume el sitio y enlaza sus versiones completas. El build del manual publica tres archivos en la raíz, junto al manual HTML:
| URL | Qué contiene |
|---|---|
/llms.txt |
Índice: título, resumen del proyecto, enlaces a las versiones completas y a la referencia OpenAPI |
/llms-full.txt |
El manual completo convertido a Markdown |
/llms-small.txt |
El mismo manual sin contenido prescindible (para contextos cortos) |
Los tres responden text/plain desde la misma API que sirve el resto
de la documentación, y solo existen si el manual está construido
(bun run docs:build): sin docs/dist responden 404.
Cómo lo usa un agente
Sección titulada «Cómo lo usa un agente»curl -s http://localhost:5000/llms.txt- Lee el índice y elige versión:
/llms-full.txt(completa) o/llms-small.txt(si el contexto es corto). - Sigue el enlace opcional a
/openapi/jsonpara el detalle de cada endpoint: cuerpos, respuestas, códigos de error y esquemas.
El índice declara además la URL base del sitio, de modo que los
enlaces relativos del texto (p. ej. /openapi) se resuelven sin
adivinar.
Cómo se genera
Sección titulada «Cómo se genera»Lo genera
starlight-llms-txt
durante bun run docs:build, a partir de las mismas páginas MDX del
manual: no hay contenido que mantener a mano. La configuración vive en
docs/astro.config.mjs:
site: URL pública del sitio (ver la nota abajo).optionalLinks: agrega el enlace a/openapi/jsonen el índice.customSelectors: limpia los anclajes de los títulos antes de convertir a Markdown.