Сборка

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

HTML

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

Чтобы запустить сборку, выполните команду с обязательными ключами запуска:

• --input, -i — путь до директории проекта;
• --output, -o — путь до директории для выходных данных (статических HTML).

yfm -i ./input-folder -o ./ouput-folder

YFM

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

Сборка в YFM позволяет использовать:

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

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

Watch-режим

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

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