Настройки сборки

    Ниже перечислены настройки сборки. Их и стандартные настройки YFM можно задать одним из способов:

    Имя ключа запуска соответствует названию настройки.

    Ключ запуска Описание
    --input, -i Путь до директории проекта (обязательный параметр).
    --output, -o Путь до директории, предназначенной для выходных данных (обязательный параметр).
    --varsPreset Название используемого пресета переменных.
    --vars, -v Значения переменных.
    --strict, -s Запуск в строгом режиме.

    Предупреждения YFM трактуются как ошибки. По умолчанию выключено.
    --quiet, -q Запуск в тихом режиме.

    Не выводить логи в stdout. По умолчанию выключено.
    --config, -c Путь до файла конфигурации.
    --singlePage Сборка проекта в виде одного HTML-файла. Подробнее в разделе Одностраничная сборка.
    --output-format Формат генерации. По умолчанию HTML, но можно настроить сборку в YFM.
    --apply-presets Подставлять значения переменных из пресетов при сборке в YFM.
    --add-system-meta Добавить переменные из секции system пресетов в метаданные файлов. По умолчанию выключено.
    --remove-hidden-toc-items Удалять скрытые страницы из результата сборки. По умолчанию выключено.
    --version Текущая версия.
    --lint-disabled Возможность отключить линтер.
    --build-disabled Возможность отключить cборку.
    --add-map-file Добавить создание file.json со всеми путями к документации. По умолчанию выключено.

    Чтобы ознакомиться с полным списком ключей, выполните команду yfm --help.