Настройки сборки через ключи запуска

Ключ запуска

Описание

--input, -i

Путь до директории проекта (обязательный параметр).

--output, -o

Путь до директории для выходных данных (обязательный параметр).

--varsPreset

Название используемого пресета переменных.

--vars, -v

Значения переменных.

--strict, -s

Запуск в строгом режиме.

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

--quiet, -q

Запуск в тихом режиме.

Не выводить логи в stdout. По умолчанию выключено.

--jobs, -j

Запуск в многопоточном режиме.
Если не указать конкретное число потоков, оно вычислится автоматически исходя из параметров системы

--jobs 4, -j4, -j

--config, -c

Путь до файла конфигурации.

--extensions, -e

Подключение внешних расширений при запуске.

Передача пути отличается для exec-флагов и конфигурации .yfm. Для exec-флагов пути указывается относительно директории выполнения команды. Для конфигурации пути передается из директории конфигурации.

Пример:

yfm -e @diplodoc/openapi-extension
yfm -e ./local-extension

--lang, --langs

Настроить поддерживаемые языки.

--output-format, -f

Формат файлов итоговой сборки. Доступные варианты: html, md. По умолчанию html.

--allow-html

Разрешить использование HTML в markdown-файлах.

--sanitize-html

Включить очистку HTML.

--merge-includes

Объеденить содержимое инклюдов с документацией.

--resource, --resources, --allow-custom-resources, --static-content

Разрешить загрузку пользовательских ресурсов на статически сгенерированные страницы.

--ignore

Не обрабатывать пути, соответствующие шаблону.

Пример:

build -i ./input -o ./output --ignore *.bad.md

или

build -i ./ -o ./build --ignore ./build

--ignore-stage

Не обрабатывать файлы оглавления с указанным уровнем. По умолчанию ["skip"].

--template

Выбрать режим работы шаблонов. По умолчанию включен текстовый режим, который игнорирует блоки кода. Используйте all или code, для обработки блоков кода.

Возможные значения:

• text;

• all;

• code.

--template-vars

Переключить режим обработки переменных в двойных фигурных скобках. По умолчанию включено.

--template-conditions

Переключить режим обработки условных операторов. По умолчанию включено.

--vcs

Включить получение данных из vcs. Этот параметр отвечает только за включение/выключение.
У каждого vcs коннектора собственная конфигурация. Она должна быть описана в документации коннектора.

--mtimes

Включить отображение даты изменения статьи. Данные берутся из vcs.

--authors

Включить отображение автора статьи. Данные берутся из vcs.

--contributors

Включить отображение контрибьюторов в статью. Данные берутся из vcs.

--lint

Подключить файл линтера. По умолчанию включено. Чтобы отключить, используйте --no-lint.

--changelogs

Бета-функция. Переключенить обработку синтаксиса экспериментального списка изменений.

--single-page

Сборка проекта в виде одного HTML-файла. Подробнее в разделе Одностраничная сборка.

--output-format

Формат генерации. По умолчанию HTML, но можно настроить сборку в YFM.

--apply-presets

Подставлять значения переменных из пресетов при сборке в YFM.

--remove-hidden-toc-items

Удалять скрытые страницы из результата сборки. По умолчанию выключено.

--version

Текущая версия.

--add-map-file

Добавлять создание file.json со всеми путями к документации. По умолчанию выключено.