ComtextBuilder — это статический сборщик сайта, предназначенный для работы с текстологическими данными в формате Comtext.

ComtextBuilder читает файлы в формате Comtext (на основе Markdown + YAML Frontmatter) из репозитория и преобразует их в современный статический сайт.

Сборка запускается через CI/CD, например, с помощью GitHub Actions:

👉 Пример workflow для деплоя

Репозиторий должен следовать рекомендуемой структуре.

• Node.js > 22
• Yarn v1.22.22 (Classic)
• Pandoc > 3.7
• xmllint (для тестов) — утилита для валидации XML по XSD схеме

💡 Pandoc используется для преобразования текстов между форматами, включая поддержку LaTeX, цитат, таблиц, математических формул и более чем 50 форматов ввода/вывода.

💡 xmllint используется в тестах для проверки валидности сгенерированных FB2 файлов по XSD схеме. Обычно устанавливается через пакет libxml2-utils (в Debian/Ubuntu) или libxml2 (в других дистрибутивах).

make install

Создайте тестовый файл в папке ./docs/.

echo '# Привет, мир!' > ./docs/index.md

Запустите локальный сервер:

make dev

Откройте сайт в браузере: http://localhost:3000

Сайт генерируется с помощью VuePress2 — современного статического генератора документов, построенного на Vue3 и Vite.

Запуск тестов

make test