llms.txt в Docusaurus
Сайты с документацией отлично подходят для llms.txt. В Docusaurus достаточно одного файла в static/.
Последнее обновление:
Куда помещать файл
Docusaurus копирует всё из static/ каталог в корень собранного сайта. Файл по адресу
static/llms.txt доступен по адресу /llms.txt. Поскольку документацию
обслуживает Docusaurus, llms.txt который сопоставляет ваши ключевые страницы документации,
особенно ценен для AI-ассистентов.
Делайте файл коротким и продуманным. Направляйте ассистентов на обзорные страницы, справочники
API, версионированную документацию, журнал изменений и политику поддержки, а не на каждый пункт
боковой панели. Если документация использует нестандартный корневой baseUrl,
проверьте и собранный путь, и публичный URL перед объявлением файла.
Метод: папка static/
- Добавьте файл:
touch static/llms.txt - Перечислите наиболее полезные страницы документации (см. руководство):
# Your Project Docs
> Documentation for Your Project: guides, API reference, and tutorials.
## Guides
- [Getting started](https://yourdomain.com/docs/intro): installation and first steps.
- [Configuration](https://yourdomain.com/docs/config): all options explained.
## Reference
- [API reference](https://yourdomain.com/docs/api): full endpoint catalog.
- Сборка и развёртывание:
npm run build.
Остерегайтесь baseUrl
Проверка настройки
curl -sI https://yourdomain.com/llms.txt | grep -i content-type
# expect: content-type: text/plain
Размещаете документацию на GitHub Pages? См. Руководство по GitHub Pages для оговорки о корневом пути. Для варианта с полным содержимым добавьте
llms-full.txt, затем проверьте оба с помощью
валидатор.