Сборка документации

Пакет CLI предоставляет утилиту yfm интерфейса командной строки.

Cборка проекта выполняется командой yfm build с параметрами:

• --input, -i — путь до директории проекта (по умолчанию — текущая папка);
• --output, -o — путь до директории для выходных данных (обязательный параметр).

# полная команда
yfm build -i ./input-folder -o ./output-folder

# также, доступна сокращенная форма без build
yfm -o ./output-folder

Стандартным выходным форматом сборщика является HTML.

Полный список параметров сборки можно найти в статье или вывести в консоли командой yfm build --help.

YFM → YFM

Вы можете выполнить промежуточную сборку YFM в YFM. Для этого при выполнении команды укажите ключ запуска --output-format=md.

При сборке в YFM выполняются:

• вставки и проверки условия видимости разделов в файлах оглавлений;
• проверки условия отображения контента на страницах документа;
• подстановки переменных, если указан параметр apply-presets;
• инлайнинг SVG-изображений;
• подстановки заголовков статей вместо {#T}.

Используйте этот вид сборки, чтобы поддерживать несколько вариантов документации для разных пользователей. Если в документации есть разделы с внутренней информацией, вы можете держать два репозитория — приватный и публичный, и синхронизировать приватный в публичный с помощью условий.

Watch-режим

Вы можете автоматизировать пересборку отдельных статей при их изменении. Для этого вызовите yfm build с параметром --watch: после сборки проекта программа перейдёт в режим инкрементальной пересборки и будет создавать или обновлять статьи после сохранения изменений в исходных файлах документации.

Для удобства, после пересборки открытого в браузере файла выполняется автоматическая перезагрузка страницы.