Настройки сборки
Ниже перечислены настройки сборки. Их и стандартные настройки YFM можно задать одним из способов:
- через ключи запуска при выполнении команды
yfm
; - в файле конфигурации.
Имя ключа запуска соответствует названию настройки.
Ключ запуска |
Описание |
|
Путь до директории проекта (обязательный параметр). |
|
Путь до директории, предназначенной для выходных данных (обязательный параметр). |
|
Название используемого пресета переменных. |
|
Значения переменных. |
|
Запуск в строгом режиме. Предупреждения YFM трактуются как ошибки. По умолчанию выключено. |
|
Запуск в тихом режиме. Не выводить логи в stdout. По умолчанию выключено. |
|
Путь до файла конфигурации. |
|
Подключение внешних расширений при запуске. Передача пути отличается для exec-флагов и конфигурации .yfm. Для exec-флагов пути указывается относительно директории выполнения команды. Для конфигурации пути передается из директории конфигурации. Пример:
|
|
Настроить поддерживаемые языки. |
|
Формат файлов итоговой сборки. Доступные варианты: |
|
Разрешить использование HTML в markdown-файлах. |
|
Включить очистку HTML. |
|
Объеденить содержимое инклюдов с документацией. Примечание Используйте вместе с параметром |
|
Разрешить загрузку пользовательских ресурсов на статически сгенерированные страницы. |
|
Не обрабатывать пути, соответствующие шаблону. Пример:
или
|
|
Не обрабатывать файлы оглавления с указанным уровнем. По умолчанию |
|
Выбрать режим работы шаблонов. По умолчанию включен текстовый режим, который игнорирует блоки кода. Используйте Возможные значения:
|
|
Переключить режим обработки переменных в двойных фигурных скобках. По умолчанию включено. |
|
Переключить режим обработки условных операторов. По умолчанию включено. |
|
Прикреплять участников к файлам. |
|
Не прикреплять авторов, если они содержат переданную строку. |
|
Подключить файл линтера. По умолчанию включено. Чтобы отключить, используйте |
|
Бета-функция. Переключенить обработку синтаксиса экспериментального списка изменений. |
|
Сборка проекта в виде одного HTML-файла. Подробнее в разделе Одностраничная сборка. |
|
Формат генерации. По умолчанию HTML, но можно настроить сборку в YFM. |
|
Подставлять значения переменных из пресетов при сборке в YFM. |
|
Добавить переменные из секции system пресетов в метаданные файлов. По умолчанию выключено. |
|
Удалять скрытые страницы из результата сборки. По умолчанию выключено. |
|
Текущая версия. |
|
Возможность отключить линтер. |
|
Возможность отключить cборку. |
|
Добавлять создание file.json со всеми путями к документации. По умолчанию выключено. |
|
Подключить обратную совместимость. |
Чтобы ознакомиться с полным списком ключей, выполните команду yfm build --help
.