Документация рядом с кодом

• Документация из существующих файлов. Читайте Markdown, MDX и локальные ресурсы прямо из репозитория или собирайте сайт из npm-пакета, зафиксированного по версии и контрольной сумме. Источники контента.
• Генерация справочника API. Превратите локальную спецификацию OpenAPI в обзор с поиском и отдельную страницу для каждой операции с параметрами, телами запросов, ответами и примерами. Справочники OpenAPI.
• Встроенный поиск. Pagefind локально индексирует страницы и заголовки. Поиск открывается сочетанием клавиш, а его ресурсы загружаются по мере необходимости. Поиск.
• Навигация для растущей документации. Организуйте разделы с помощью вкладок и групп в боковой панели, добавьте оглавления и ссылки на предыдущую и следующую страницы, используйте выдвижное меню на мобильных устройствах. Поиск и навигация.
• Компоненты для технических материалов. Используйте вкладки, примечания, карточки, шаги, группы кода, подсветку с кнопками копирования и изолированные интерактивные примеры в MDX. Компоненты для подготовки материалов.
• Тема в стиле вашего продукта. Настройте фирменные цвета, семантические палитры, шрифты, типографику и части компонентов через Tasty и Glaze. Светлый, тёмный и высококонтрастный режимы получают статический CSS, созданный при сборке. Тема и компоненты.
• Языки и версии. Публикуйте переводы и версии документации. Переключатели открывают соответствующую страницу, если она существует. Языки и версии.
• Проверки перед публикацией. Находите неработающие ссылки, отсутствующие ресурсы, дублирующиеся маршруты и неверную навигацию с указанием исходного файла. Размещайте заранее созданный HTML на любом статическом хостинге. Проверки качества.
• Страницы для распространения и чтения. Публикуйте канонические URL, превью для социальных сетей, карты сайта, Markdown для скачивания и индекс llms.txt для агентов программирования. Метаданные публикации.

Выполните эти команды в проекте, где уже есть README.md или каталог docs/:

npm create @tenphi/cookbook@latest docs-site -- --source . --yes
cd docs-site
npm run dev

Cookbook читает файлы на их текущем месте. Вы также можете создать новый сайт, описать именно те файлы, которые опубликованы в npm, или добавить Cookbook в проект Astro.

Текущая страница находится в docs/ru/index.md. Небольшое приложение Astro собирает сайт прямо из каталога docs/ в репозитории. Навигация, поиск, элементы управления кодом, ссылки на редактирование и даты из Git доступны любому сайту Cookbook.

• Начало работы: репозитории, npm-пакеты и существующие проекты Astro.
• Сравнение инструментов: модель контента и настройки Cookbook.
• Примеры: репозитории, монорепозитории, пакеты и общие темы.
• Поиск и навигация: как читатели находят страницы.
• Подготовка материалов: страницы, компоненты и интерактивные примеры.
• Тема и компоненты: фирменный стиль, токены, шрифты и собственные компоненты.
• Развёртывание: проверка и статический хостинг.

Остальная документация пока доступна на английском языке. Также см. работу с ИИ-агентами, справочник конфигурации, настройки публикации и справочник CLI.