Перейти к содержимому
Выберите тему

llms.txt в генераторах документации

Как включить llms.txt в Starlight, VitePress, Docusaurus, MkDocs и Nuxt - рабочая настройка для каждого, какие файлы создаёт плагин и что проверить после сборки

Генератор Пакет llms.txt llms-full.txt Markdown-версии страниц
Starlight starlight-llms-txt да да, плюс llms-small.txt не заявлены
VitePress vitepress-plugin-llms да да да
Docusaurus docusaurus-plugin-llms да да по настройке
Docusaurus @signalwire/docusaurus-plugin-llms-txt да по настройке да
MkDocs mkdocs-llmstxt да по настройке для перечисленных файлов
Nuxt nuxt-llms да по настройке нет
Окно терминала
pnpm add starlight-llms-txt
astro.config.mjs
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightLlmsTxt from 'starlight-llms-txt'
export default defineConfig({
site: 'https://example.ru/',
integrations: [
starlight({
title: 'Документация',
plugins: [starlightLlmsTxt()],
}),
],
})

Поле site обязательно: без него плагин не построит абсолютные адреса. На выходе три файла: llms.txt, llms-full.txt и сокращённый llms-small.txt.

Платформа Что создаётся само
Mintlify llms.txt и llms-full.txt в корне проекта; очень длинный индекс делится на части
GitBook llms.txt, llms-full.txt и Markdown-версия любой страницы по адресу с .md

Этим объясняется, почему у множества сайтов документации файлы есть, хотя владельцы ничего не настраивали.

Плагины создают файлы, но не все добавляют на страницы связи из второй редакции proposal. Проверь, есть ли в коде страницы эти строки:

<link rel="alternate" type="text/markdown" href="/docs/page.md">
<link rel="describedby" href="/llms.txt">

Если их нет, добавь через шаблон заголовка страницы. Подробно: Обнаружение файла и Markdown-версий.

  1. Файл llms.txt появился в папке со сборкой и отвечает на сайте кодом 200.
  2. В нём есть название и описание сайта.
  3. Адреса в ссылках абсолютные и с верным доменом.
  4. Черновики и скрытые страницы в файл не попали.
  5. Размер llms-full.txt разумный.
  6. Markdown-версии страниц открываются, если плагин их создаёт.

Команды для проверки: Проверка файлов и разметки.