Blume — это open-source фреймворк для документации на базе Markdown, предназначенный для создания готовых к работе сайтов с нулевой конфигурацией, встроенными функциями ИИ и поддержкой интерактивных справочников API.
Назначение продукта и его официальное позиционирование
Blume упрощает создание веб-сайтов с документацией, позволяя пользователям публиковать контент напрямую из Markdown-файлов. Он автоматизирует такие важные функции, как навигация, SEO и поиск, позволяя разработчикам сосредоточиться на контенте, а не на обслуживании шаблонов.
Платформа создана как для людей, так и для программных агентов, предлагая нативную поддержку форматов, дружественных к LLM, таких как llms.txt и MCP-серверы. Она предоставляет полный набор компонентов и инструментов CLI для управления всем жизненным циклом документации.
Сценарии, подтверждённые официальными источниками
Создание комплексных, интерактивных сайтов с поддержкой поиска для программных проектов и инструментов разработчика.
Генерация интерактивных страниц справочников API из спецификаций OpenAPI или AsyncAPI со встроенными песочницами для тестирования.
Описанный в документации процесс, если он доступен
Запустите команду npx blume init для создания структуры нового проекта документации с необходимыми конфигурационными файлами.
Разместите файлы Markdown или MDX в папке проекта для автоматической генерации навигации по сайту и структуры страниц.
Blume разработан для преодоления разрыва между документацией, читаемой человеком, и знаниями, доступными для машин. Благодаря автоматической генерации машиночитаемых индексов и предоставлению доступа к исходному Markdown по каждому URL-адресу, инструмент позволяет моделям ИИ и агентам кодирования точно интерпретировать и использовать корпус документации.
Проверки на собственных материалах и рабочих процессах
Какие источники и когда были проверены
Ответы на основе карточки продукта с проверенными источниками
Нет, Blume разработан для работы с нулевой конфигурацией. Простая папка с файлами Markdown служит полноценным проектом, а навигация выстраивается автоматически на основе структуры ваших файлов.
Да, Blume поддерживает несколько источников контента. Вы можете настроить фреймворк для получения данных из удаленных репозиториев, CMS-платформ или пользовательских бэкендов через конфигурацию источников.
Blume поддерживает интерактивные справочники API, принимая спецификации OpenAPI или AsyncAPI. Он преобразует их в страницы документации, которые включают схемы и живую песочницу для тестирования запросов.
Да, Blume поддерживает интернационализацию для 36 локалей, включая полную поддержку языков с письмом справа налево, что позволяет вашей документации охватить глобальную базу пользователей.
Blume включает встроенный CLI, который автоматизирует задачи обслуживания, такие как проверка ссылок, аудит производительности SEO, оценка качества документации и управление обновлениями переводов.
