DocBuilder 2.0

Портал документации и генерация PDF в одном флаконе

• Контент. Переиспользование текстов, написанных техническими писателями. Концепция единого источника из системы контроля версий git;
• Форматирование. Не использование форматирования средствами Word, вместо этого упрощенные “теги” (проще чем html);
• Дизайн. Не использование шаблонизатора YAML. Вместо этого используется CSS;

Основано на идеях и продуктах

• https://asciidoc.org/
• https://antora.org/
• https://github.com/Mogztter/asciidoctor-web-pdf

CLI (command line interface)

Запускалось и работало на ОС:

• РЕД ОС 3.2
• Ubuntu 20
• WSL2 (Windows Subsystem for Linux)

Предустановка (один раз после клонирования репо)

• cd docbuilder-repo (или в вами названную папку)
• npm install (установит пакеты анторы и асцидоктор веб пдф локально, то есть в WSL или в убунте должна быть как минимум установлена nodejs среда. То есть выхлоп сообщений node -v и npm -v должен выдавать версии нодовского пакетного менеджера, а не ошибку. В дальнейшем мы обращаемся к этим единожды загруженным пакетам локально в текущей папке а не в системе). Antora и Asciidoctor-web-pdf используются локально (то есть входят в каталог). Также предварительно в wsl или ubuntu должно быть установлено: git и python (версия питона примерно 3.8), так как они используются глобально на уровне системы, а не каталога-репозитория.

Использование

$ python3 ./cli.py