Секции и структура
Организация разделов в llms.txt
Типы секций
Заголовок раздела «Типы секций»Основные секции
Заголовок раздела «Основные секции»Рекомендуемые названия секций для документации:
| Секция | Назначение | Приоритет |
|---|---|---|
## Docs | Основная документация | Высокий |
## API | API Reference | Высокий |
## Guides | Руководства и туториалы | Средний |
## Examples | Примеры кода | Средний |
## Reference | Справочные материалы | Средний |
Дополнительные секции
Заголовок раздела «Дополнительные секции»| Секция | Назначение | Приоритет |
|---|---|---|
## Blog | Статьи и новости | Низкий |
## Changelog | История изменений | Низкий |
## Community | Сообщество, форумы | Низкий |
## Optional | Второстепенные ресурсы | Может быть пропущен |
Секция Optional
Заголовок раздела «Секция Optional»Назначение
Заголовок раздела «Назначение»Секция ## Optional имеет специальное значение в спецификации. Ресурсы в ней могут быть пропущены при формировании контекста для LLM.
Когда использовать
Заголовок раздела «Когда использовать»## Optional
- [Changelog](https://example.com/changelog): История версий- [Roadmap](https://example.com/roadmap): Планы развития- [Contributing](https://example.com/contributing): Как внести вклад- [Code of Conduct](https://example.com/coc): Правила сообщества- [License](https://example.com/license): Лицензия MITЛогика обработки
Заголовок раздела «Логика обработки»def get_context(llms_txt, include_optional=True): sections = parse_llms_txt(llms_txt)
if not include_optional: sections.pop('Optional', None)
return sectionsПорядок секций
Заголовок раздела «Порядок секций»Рекомендуемый порядок
Заголовок раздела «Рекомендуемый порядок»- H1 заголовок — название проекта
- Blockquote — краткое описание
- Описательный текст — важные детали
- Основные секции — Docs, API, Guides
- Дополнительные секции — Examples, Reference
- Optional — всегда последняя
Пример полной структуры
Заголовок раздела «Пример полной структуры»# FastHTML
> Modern Python web framework for building fast, interactive web applications.
Key features:- No JavaScript required- HTMX integration- Server-side rendering
## Documentation
- [Getting Started](https://fastht.ml/docs/): Quick start guide- [Tutorial](https://fastht.ml/docs/tutorial): Step-by-step tutorial- [API Reference](https://fastht.ml/docs/api): Complete API docs
## Guides
- [Forms](https://fastht.ml/docs/guides/forms): Working with forms- [Database](https://fastht.ml/docs/guides/db): Database integration- [Deployment](https://fastht.ml/docs/guides/deploy): Production deployment
## Examples
- [Todo App](https://github.com/fasthtml/examples/todo): Basic todo application- [Blog](https://github.com/fasthtml/examples/blog): Blog with comments- [E-commerce](https://github.com/fasthtml/examples/shop): Shopping cart demo
## Optional
- [Changelog](https://fastht.ml/changelog): Version history- [Contributing](https://github.com/fasthtml/fasthtml/CONTRIBUTING.md): Contribution guide- [Discord](https://discord.gg/fasthtml): Community chatЛокализация секций
Заголовок раздела «Локализация секций»Мультиязычные сайты
Заголовок раздела «Мультиязычные сайты»Для сайтов с несколькими языками можно создавать отдельные файлы:
/llms.txt → Основной (английский)/ru/llms.txt → Русская версия/zh/llms.txt → Китайская версияПереводы названий секций
Заголовок раздела «Переводы названий секций»## Документация
- [Быстрый старт](https://example.com/ru/docs/start): Начните здесь- [Справочник API](https://example.com/ru/docs/api): Описание APIГруппировка ссылок
Заголовок раздела «Группировка ссылок»По типу контента
Заголовок раздела «По типу контента»## Tutorials
- [Beginner Tutorial](url): For new users (30 min)- [Advanced Tutorial](url): Deep dive (2 hours)- [Video Course](url): Video walkthrough
## API Reference
- [REST API](url): HTTP endpoints- [GraphQL API](url): GraphQL schema- [SDK Reference](url): Client librariesПо платформе
Заголовок раздела «По платформе»## JavaScript
- [npm Package](url): Installation and usage- [Browser Guide](url): Browser integration
## Python
- [PyPI Package](url): pip installation- [Django Integration](url): Django setupИзбегайте
Заголовок раздела «Избегайте»Слишком много секций
Заголовок раздела «Слишком много секций»❌ Плохо:
## Getting Started## Installation## Configuration## Basic Usage## Advanced Usage## Troubleshooting## FAQ## API## REST## GraphQL## WebSocket...✅ Хорошо:
## Documentation
- [Getting Started](url): Includes installation, config, basic usage- [Advanced Guide](url): Advanced topics and troubleshooting
## API Reference
- [Complete API](url): REST, GraphQL, WebSocketПустые секции
Заголовок раздела «Пустые секции»Не создавайте секции без ссылок:
## Coming Soon
(пусто)Дублирование ссылок
Заголовок раздела «Дублирование ссылок»Одна ссылка должна быть только в одной секции.