Настройки YFM-проекта

В зависимости от используемого инструмента вы можете задать стандартные настройки YFM-проекта одним из способов:

Название

Описание

Тип

Значение по умолчанию

vars

Использование переменных

Object

{}

allowHTML

Разрешить использование HTML в разметке

bool

false

applyPresets

Использовать переменные из файла presets.yaml

bool

false

linkify

Преобразовывать ссылкоподобные строки в ссылки

bool

false

breaks

Переносить строки по символу перевода каретки

bool

true

conditionsInCode

Выполнять условия в блоках кода

bool

false

disableLiquid

Отключить использование переменных

bool

false

supportGithubAnchors

Генерировать дополнительные якоря, совместимые с GitHub

bool

false

lang

Язык локализации дефолтных текстов.
Для следующих языков контент будет отображаться в формате RTL (right-to-left)

string

ru

metrika

Использовать счётчик Яндекс.Метрики с заданным id.

Можно подключить несколько счетчиков:

docs-viewer:
  metrika: [21930706, 96924079, 96924106]

string \| string[]

undefined

needToSanitizeHtml

Нужно ли санитайзить сгенерированный HTML

bool

true

remove-hidden-toc-items

Убрать из оглавления все объекты, отмеченные атрибутом hidden: true

bool

false

merge-includes

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

Примечание

Используйте вместе с параметром output-format: md.

bool

false

allow-custom-resources

static-content

resource

resources <value...>

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

bool

false

add-system-meta

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

bool

false

output-format

Формат файлов итоговой сборки

string (html или md)

html

sanitizeOptions

Конфигурация санитайзера

Object

undefined

singlePage

Собирать однострачник из всех файлов проекта

bool

false

strict

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

bool

true

linkifyTlds

Настройка tld для плагина linkify

string \| string[]

undefined

add-map-file

Создает json-файл со всеми путями проекта

bool

false

analytics

Конфигурация для модуля аналитки

Object

undefined

analytics.gtm

Настройки Google Tag Manager аналитики

Object

undefined

analytics.gtm.id

Идентификатор Google Tag Manager в формате GTM-*

string

undefined

analytics.gtm.mode

Тип уведомления перед отправкой событий base или notification

string

base

csp

Управление Content Security Policy (CSP)

string

-