--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://3y3.dev/en/tools/docs/settings.md - https://3y3.dev/ru/tools/docs/settings.md - href: ru/tools/docs/settings.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt updatedAt: '2026-08-06T11:19:50.000Z' --- > **Documentation Index:** Fetch the complete configuration index at https://3y3.dev/ru/llms.txt # Параметры сборки документации Ниже перечислены параметры сборки, поддерживаемые при выполнении команды `yfm build`. #| || **Ключ запуска** | **Описание** || || `--input, -i` | Путь до директории проекта. По умолчанию – текущая директория. || || `--output, -o` | Путь до директории для выходных данных (обязательный параметр). || || `--vars-preset ` {#vars-preset} | Название используемого [пресета переменных](https://3y3.dev/ru/project/presets.md). || || `--vars, -v` | Значения [переменных](https://3y3.dev/ru/syntax/vars.md). || || `--strict, -s` | Запуск в строгом режиме. Предупреждения YFM трактуются как ошибки. По умолчанию выключено. || || `--quiet, -q` | Запуск в тихом режиме. Не выводить логи в stdout. По умолчанию выключено. || || `--jobs, -j` | Запуск в многопоточном режиме. Если не указать конкретное число потоков, оно вычислится автоматически исходя из параметров системы `--jobs 4`, `-j4`, `-j` || || `--config, -c` {#config} | Путь до [файла конфигурации](https://3y3.dev/ru/settings.md). || || `--extensions, -e` | Подключение внешних расширений при запуске. Передача пути отличается для exec-флагов и конфигурации .yfm. Для exec-флагов пути указывается относительно директории выполнения команды. Для конфигурации пути передается из директории конфигурации. Пример: ```bash yfm -e @diplodoc/openapi-extension yfm -e ./local-extension ``` || || `--watch, -w` | Запуск [watch-режима сборки](https://3y3.dev/ru/tools/docs/build.md#watch). || || `--lang, --langs` | Настроить поддерживаемые языки. || || `--output-format, -f` | Формат файлов итоговой сборки. Доступные варианты: `html`, `md`. По умолчанию `html`. || || `--allow-html` | Разрешить использование HTML в markdown-файлах. || || `--sanitize-html` | Включить очистку HTML. || || `--allow-custom-resources` | Разрешить загрузку пользовательских ресурсов на статически сгенерированные страницы. || || `--static-content` | Собирать html-контент статьи как часть вёрстки. По умолчанию, он находится в js-объекте и вставляется в страницу на этапе отрисовки в браузере. || || `--theme ` | Подключить темизатор. Подробнее - [здесь](https://3y3.dev/ru/style/theme.md). || || `--ignore` | Не обрабатывать пути, соответствующие шаблону. Пример: ```bash build -i ./input -o ./output --ignore *.bad.md ``` или ```bash build -i ./ -o ./build --ignore ./build ``` || || `--ignore-stage` | Не обрабатывать файлы оглавления с указанным уровнем. По умолчанию `["skip"]`. || || `--template` | Выбрать режим работы [шаблонов](https://3y3.dev/ru/syntax/vars.md). По умолчанию включен текстовый режим, который игнорирует блоки кода. Используйте `all` или `code`, для обработки блоков кода. Возможные значения: - `text`; - `all`; - `code`. || || `--template-vars` | Переключить режим обработки [переменных](https://3y3.dev/ru/syntax/vars.md#subtitudes) в двойных фигурных скобках. По умолчанию включено. || || `--template-conditions` | Переключить режим обработки [условных операторов](https://3y3.dev/ru/syntax/vars.md#conditions). По умолчанию включено. || || `--vcs` | Включить получение данных из vcs. Этот параметр отвечает только за включение/выключение. У каждого vcs коннектора собственная конфигурация. Она должна быть описана в документации коннектора. || || `--mtimes` | Включить отображение даты изменения статьи. Данные берутся из vcs. || || `--authors` | Включить отображение автора статьи. Данные берутся из vcs. || || `--contributors` | Включить отображение контрибьюторов в статью. Данные берутся из vcs. || || `--lint` | Подключить [файл линтера](https://3y3.dev/ru/project/lint.md). По умолчанию включено. Чтобы отключить, используйте `--no-lint`. || || `--llms` | Включить [генерацию файлов llms.txt и llms-full.txt](https://3y3.dev/ru/guides/llms.md) для проекта. || || `--llms-full-max-size ` | Ограничение на размер генерируемого файла llms-full.txt одной статьи, в случае превышения которого наполнение файла данными останавливается с кодом ##YFM022## (сборка не завершается ошибкой). Принимает числа и строки вида: ##1024##, ##512K##, ##2M##. || || `--changelogs` | Бета-функция. Переключить обработку синтаксиса экспериментального списка изменений. || || `--single-page` | Сборка проекта в виде одного HTML-файла. Подробнее в разделе [Одностраничная сборка](https://3y3.dev/ru/tools/docs/singlepage.md). || || `--output-format` | Формат генерации. По умолчанию HTML, но можно настроить [сборку в YFM](https://3y3.dev/ru/tools/docs/build.md#yfm). || || `--apply-presets` | Подставлять значения переменных из пресетов при сборке в YFM. || || `--remove-hidden-toc-items` | Удалять скрытые страницы из результата сборки. По умолчанию выключено. || || `--skip-html-extension` | Удалять из внутренних ссылок на статьи расширение `.html` и имя файла `index.html`. {% note info %} Для корректного открытия ссылок без расширений необходимо настроить веб-сервер на обработку путей без `.html` и `index.html` на конце. {% endnote %} || || `--add-map-file` | Добавлять создание file.json со всеми путями к документации. По умолчанию выключено. || || `--build-stats` {#build-stats-flag} | Записать рядом с output файл `yfm-build-stats.json` с метриками сборки (длительность, счётчики страниц и ассетов, размер артефактов). Подробнее — в [Статистика сборки](https://3y3.dev/ru/tools/docs/build.md#build-stats). По умолчанию включено для сборок `--output-format=md`, для остальных — выключено. Чтобы отключить, используйте `--no-build-stats`. || || `--build-content` {#build-content-flag} | Записать рядом с output файл `yfm-build-content.json` с хешами содержимого каждого файла и зависимостями `страница → ассеты`. Используется внешними инструментами (переиндексация поиска, уведомления об изменениях) для вычисления набора страниц, изменившихся между двумя сборками. Подробнее — в [Карта содержимого сборки](https://3y3.dev/ru/tools/docs/build.md#build-content). По умолчанию включено для сборок `--output-format=md`, для остальных — выключено. Чтобы отключить, используйте `--no-build-content`. || || `--disable-csp` | Отключить добавление мета-тега [Content-Security-Policy](https://3y3.dev/ru/guides/csp.md#disable-csp) в сгенерированные HTML-страницы. По умолчанию включено. || || `--max-asset-size ` {#max-asset-size} | Ограничение на размер ассета в проекте, в случае превышения которого сборка завершается с ошибкой ##YFM013##. Принимает числа и строки вида: ##1024##, ##512K##, ##2M##. Если указать ##0##, то проверка размера ассетов выполняться не будет. По умолчанию ##64M##. || || `--max-html-size ` {#max-html-size} | Ограничение на размер html-контента одной статьи, в случае превышения которого сборка завершается с ошибкой ##YFM012##. Принимает числа и строки вида: ##1024##, ##512K##, ##2M##. Работает только при сборке `--output-format html`. По умолчанию ##42M##, максимальное значение ##96M##. || || `--max-inline-svg-size ` {#max-inline-svg-size} | Максимально допустимый размер svg-изображения, при котором оно [инлайнится в контент статьи](https://3y3.dev/ru/syntax/media.md#img-inline) автоматически. В случае превышения размера svg-изображение вставляется через тег ##\##. Принимает числа и строки вида: ##1024##, ##512K##, ##2M##. Если указать ##0##, то svg-изображения не будут инлайниться при сборке. По умолчанию ##2M##, максимальное значение ##16M##. || || `--max-openapi-include-size ` {#max-openapi-include-size} | Максимально допустимый размер файла, собранного из [OpenAPI-спецификации](https://3y3.dev/ru/guides/openapi.md). В случае превышения размера файла, из него вырезается json-схема. Принимает числа и строки вида: ##1024##, ##512K##, ##2M##. Если указать ##0##, ограничения нет. || || `--multiline-term-definitions` {#multiline-term-definitions} | Включает поддержку множественных переносов строк во [всплывающих подсказках](https://3y3.dev/ru/syntax/term.md). || || `--version` | Текущая версия. || |# Чтобы ознакомиться с полным списком ключей, выполните команду `yfm build --help`.