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

Параметр

Описание

Тип и значение по умолчанию

allowHTML

Разрешить использование html-элементов в разметке.

bool

false

apply-presets

Применять ли пресеты переменных.

Подробнее о пресетах.

bool

false

breaks

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

bool

true

conditionsInCode

Разрешить блоки кода с условиями с помощью операторов.

bool

false

langs

Массив языков, участвующих в сборке.

—

—

lint

Подключить файл линтера.

bool

false

needToSanitizeHtml

Включает очистку HTML-разметки от потенциально опасных элементов в .md-файлах с помощью HTML-санитайзера. Определяет разрешенные и запрещенные теги, атрибуты, стили и другие элементы при очистке HTML-контента.

bool

true

output-format

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

string (html или md)

html

pdf

При значении pdf: true для документа будет собираться pdf-версия. Чтобы сборка прошла корректно, обязательно должен быть указан параметр singlePage: true. После завершения сборки в левом нижнем углу документа отображается значок собранного PDF-файла, который можно скачать.

bool

false

remove-hidden-toc-items

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

bool

false

singlePage

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

bool

false

strict

Cтрогий режим сборки, все предупреждения YFM отображаются как ошибки.

bool

false

varsPreset

Имя пресета переменных, который необходимо использовать при сборке.

string

—

Название

Описание

Тип и значение по умолчанию

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

disableLiquid

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

bool

false

favicon-src

Иконка во вкладке браузера.

Можно использовать любую ссылку на изображение, подходящее под стандартные требования к фавиконкам.

string

—

lang

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

string

ru

langs

Массив языков, отображаемых в интерфейсе документации. Язык по умолчанию при открытии страницы — первый элемент в массиве.

input-folder
|-- .yfm
|-- ru
    |-- toc.yaml
    |-- index.md
|-- en
    |-- toc.yaml
    |-- index.md

string[]

—

linkify

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

Пример ссылки: https://diplodoc.com/ru или diplodoc.com/ru.

bool

false

logo-options

Настройки логотипа:

• src — ссылка на изображение для светлой темы;

• src-dark — ссылка на изображение для темной темы;

• src-mobile — ссылка на изображение для светлой темы на мобильных;

• src-mobile-dark — ссылка на изображение для темной темы на мобильных;

• src-preview — логотип для превью ссылки при шеринге на внешних ресурсах, применяется стандарт OpenGraph;

• url — ссылка, на которую перенаправляет при нажатии на логотип. Можно задать шаблон ссылки с параметром {lang}, чтобы он заменился на текущий язык документации при переходе. Например, ссылка https://diplodoc.com/docs/{lang}/ при переходе из документации на русском языке будет вести на https://diplodoc.com/docs/ru/;

• title — текст, который показывается вместо логотипа, если он не задан.

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

Для указанных выше параметров можно настроить определенные логотипы для разных языков документации.

src: logo

src:
  ru: logo1
  en: logo2
  default: logo3

—

—

metrika

Номер счетчика Яндекс Метрики.

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

docs-viewer:
  metrika: [21930706, 96924079]

string | string[]

undefined

no-index

Запрет на индексирование внешними роботами.

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

bool

false

project-name

Формирует URL-адрес проекта. Требования:

• только нижний регистр;
• только латиница, цифры, дефис и нижнее подчеркивание;
• максимальная длина — 63 символа.

string

—

supportGithubAnchors

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

bool

false

themes

Выбор темы оформления: светлая или темная. По умолчанию доступны обе. Можно отключить одну из них, указав используемую по умолчанию, например:

themes: ['light']

string

light

Название

Описание

Тип и значение по умолчанию

allow-custom-resources

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

bool

false

static-content

Разрешить использовать статический контент (например, файлов изображений, CSS или JS).

bool

false

resources <value...>

Список разрешенных ресурсов.

—

—

csp

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

csp:
	- "script-src":
    	- "self"
        - "domain1.com"
        - "domain2.com"
        "*.domain3.com"
    - "style-src":
    	- "self"
    ...
    ...
    ...
    

<meta http-equiv="content-security-policy" content="script-src 'self' domain1.com domain2.com *.domain3.com; style-src 'self' ... ... ...">

object

—