Об этом проекте
Ciderpress — это документационный фреймворк, предназначенный для монорепозиториев, который преобразует markdown-файлы в полноценный сайт документации при минимальной конфигурации.
Ключевые возможности:
- Соответствие структуре: адаптируется к существующей структуре репозитория, а не навязывает жёсткую структуру.
- Единая конфигурация: боковые панели, навигация, нижний колонтитул, ссылки для редактирования, отображение версий, объявления и темизация управляются из одного файла конфигурации.
- Встроенные темы: поставляется с четырьмя темами — honeycrisp, grannysmith, midnight и arcade — каждая с полной поддержкой тёмного режима. Также поддерживаются пользовательские темы.
- Поддержка монорепозиториев: включает карточки рабочих пространств, интеграцию с OpenAPI и поддержку шаблонов Liquid, ориентируясь на внутреннюю документацию для разработчиков.
Для использования требуется установка через npm и определение файла конфигурации (ciderpress.config.ts), в котором объявляются разделы с заголовком, путём и шаблонами включения markdown. Инструмент предоставляет три команды: `npx ciderpress dev` для запуска сервера разработки с горячей перезагрузкой, `npx ciderpress build` для создания production-сборки и `npx ciderpress serve` для локального предпросмотра собранного сайта.
Лицензировано под MIT.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.