К содержанию

Навигация

section.json и page.json

section.json настраивает раздел: соседнюю страницу-обзор и все страницы каталога. <page>.page.json уточняет одну страницу и дополнительно задаёт её description и slug. Как уровни наследуются и сбрасываются, описано в разделе «Сайт, раздел и страница».

Как читать таблицы полей

Таблицы строятся при сборке из JSON Schema. Если поле не задано в файле, действует значение уровнем выше: из ближайшего section.json родительского каталога или из docara.json. Строка «По умолчанию» под описанием показывает встроенное значение Docara, если поле не задано нигде. В «Технических данных» — тип, правило проверки и место в схеме.

section.json

Основное

ПолеЧто задаёт
/localeЯзык раздела. Должен совпадать с языком каталога; иначе сборка остановится.
По умолчанию: язык каталога раздела
Технические данные

Тип: string · Уровень: section

Проверка: format="docara-bcp47"

Схема: resources/schemas/section.schema.json#/properties/locale

/presetТип всех страниц раздела: docs или landing.
Технические данные

Тип: string · Уровень: section

Проверка: enum=["docs","landing"]

Схема: resources/schemas/section.schema.json#/properties/preset

/schema
обязательное
Тип файла. Всегда docara.section.v1.
Технические данные

Тип: string · Уровень: section

Проверка: const="docara.section.v1"

Схема: resources/schemas/section.schema.json#/properties/schema

/titleНазвание раздела (каталога) в меню слева.
По умолчанию: имя каталога
Технические данные

Тип: string · Уровень: section

Проверка: minLength=1

Схема: resources/schemas/section.schema.json#/properties/title

/versionВерсия формата файла. Допустимо только 1.
Технические данные

Тип: integer · Уровень: section

Проверка: const=1

Схема: resources/schemas/section.schema.json#/properties/version

Внешний вид

ПолеЧто задаёт
/brandingБренд в шапке сайта: название, подпись, логотип, значок вкладки и картинка для соцсетей.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/branding

/branding/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/$reset

/branding/creditПодпись «Сделано на Docara» внизу меню. Задаётся только в docara.json.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/credit

/branding/faviconЗначок сайта во вкладке браузера.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: section

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/favicon

/branding/labelКороткая подпись рядом с названием, например «Документация».
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: section

Проверка: minLength=1

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/label

/branding/logoФайл логотипа для шапки, путь от корня проекта.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: section

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo

/branding/logo_darkЛоготип для тёмной темы. Нужен основной logo.
По умолчанию: основной logo
Технические данные

Тип: string · Уровень: section

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo_dark

/branding/modeЧто показать: full — логотип, название и подпись; compact — логотип и название; logo — только логотип; text — только текст.
По умолчанию: наследуется, иначе "full"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["full","compact","logo","text"]

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/mode

/branding/share_imageКартинка для превью ссылки в соцсетях: PNG, JPEG или WebP. Работает только с site_url.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: section

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/share_image

/branding/sizeРазмер логотипа и названия: small, medium или large.
По умолчанию: наследуется, иначе "medium"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["small","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/size

/branding/titleНазвание бренда в шапке. Добавляется к заголовку вкладки браузера.
По умолчанию: title сайта
Технические данные

Тип: string · Уровень: section

Проверка: minLength=1

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/title

/layoutМакет страницы: ширина, отступы, полосы прокрутки и области.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout

/layout/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/$reset

/layout/containerШирина страницы.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/container

/layout/container/max
обязательное
Максимальная ширина страницы по шкале SIMAI Framework, от 1 до 8.
По умолчанию: наследуется, иначе 7
Технические данные

Тип: integer · Уровень: section

Проверка: minimum=1; maximum=8

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/container/properties/max

/layout/contentРасстояние между блоками статьи.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/content

/layout/content/gap
обязательное
Отступ между соседними блоками статьи, от 0 до 8. 0 — обычный поток текста.
По умолчанию: наследуется, иначе null
Технические данные

Тип: integer · Уровень: section

Проверка: minimum=0; maximum=8

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/content/properties/gap

/layout/keyКакой макет использовать. В Docara есть docara.docs.
По умолчанию: наследуется, иначе "docara.docs"
Технические данные

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/key

/layout/regionsОбласти макета: шапка, меню, основная часть, оглавление, подвал.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/regions

/layout/regions/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/regions/properties/$reset

/layout/regions/<область>Настройки одной области: включена ли она и что в ней.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region

/layout/regions/<область>/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/$reset

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/$reset

/layout/regions/<область>/enabledВключает или выключает область. Основную часть main выключить нельзя.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/enabled

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/enabled

/layout/regions/<область>/sectionsСекции области по порядку, не больше 8. Список заменяет унаследованный целиком.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections

Тип: array · Уровень: section

Проверка: maxItems=8

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/sections

/layout/regions/<область>/sections/*Одна секция области.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*

Тип: object · Уровень: section

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region_section

/layout/regions/<область>/sections/*/blocksБлоки секции, от 1 до 12. Только для секций, которые принимают свои блоки.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks

Тип: array · Уровень: section

Проверка: minItems=1; maxItems=12

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/blocks

/layout/regions/<область>/sections/*/blocks/*Один блок секции: простой элемент с текстом или Smart-компонент.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*

Тип: oneOf · Уровень: section

Проверка: oneOf=2

Схема: resources/schemas/presentation.schema.json#/$defs/region_block

/layout/regions/<область>/sections/*/blocks/*/bindДанные сайта, которые получает Smart-компонент, например docara.navigation.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/bind

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9-]*\\.[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/bind

/layout/regions/<область>/sections/*/blocks/*/block
обязательное
Тип блока для простого элемента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/block

/layout/regions/<область>/sections/*/blocks/*/block
обязательное
Тип блока для Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/block

/layout/regions/<область>/sections/*/blocks/*/element
обязательное
Элемент: тег, текст и, при необходимости, ссылка, подпись и классы.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element

Тип: object · Уровень: section

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element

/layout/regions/<область>/sections/*/blocks/*/element/aria_labelПодпись элемента для программ экранного доступа.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/aria_label

Тип: string · Уровень: section

Проверка: minLength=1; maxLength=160

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/aria_label

/layout/regions/<область>/sections/*/blocks/*/element/hrefСсылка внутри сайта для тега a: путь от / или #якорь.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/href

Тип: string · Уровень: section

Проверка: pattern="^(?:/|[/#][^\\u0000-\\u0020\\\"'<>\\\\]+)$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/href

/layout/regions/<область>/sections/*/blocks/*/element/tag
обязательное
HTML-тег элемента: div, p, span или a.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/tag

Тип: string · Уровень: section

Проверка: enum=["div","p","span","a"]

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/tag

/layout/regions/<область>/sections/*/blocks/*/element/text
обязательное
Текст элемента без HTML, до 500 символов.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/text

Тип: string · Уровень: section

Проверка: minLength=1; maxLength=500

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/text

/layout/regions/<область>/sections/*/blocks/*/element/utilitiesКлассы SIMAI Framework для элемента, не больше 16.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities

Тип: array · Уровень: section

Проверка: maxItems=16; uniqueItems=true

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities

/layout/regions/<область>/sections/*/blocks/*/element/utilities/*Один класс SIMAI Framework.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities/*

Тип: string · Уровень: section

Проверка: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities/items

/layout/regions/<область>/sections/*/blocks/*/id
обязательное
Постоянный идентификатор блока внутри секции.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/id

/layout/regions/<область>/sections/*/blocks/*/id
обязательное
Постоянный идентификатор блока внутри секции.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/id

/layout/regions/<область>/sections/*/blocks/*/props
обязательное
Параметры Smart-компонента, не больше 32.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/props

Тип: object · Уровень: section

Проверка: maxProperties=32

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/props

/layout/regions/<область>/sections/*/blocks/*/slot
обязательное
Место внутри секции, куда ставится блок.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/slot

/layout/regions/<область>/sections/*/blocks/*/slot
обязательное
Место внутри секции, куда ставится блок.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/slot

/layout/regions/<область>/sections/*/blocks/*/smart
обязательное
Имя Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/smart

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/smart

/layout/regions/<область>/sections/*/blocks/*/viewВариант отображения Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/view

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/view

/layout/regions/<область>/sections/*/id
обязательное
Постоянный идентификатор секции внутри области.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/id

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/id

/layout/regions/<область>/sections/*/section
обязательное
Тип секции, например docara.navigation или docara.shell.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/section

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/section

/layout/regions/<область>/sections/*/utilitiesКлассы SIMAI Framework для оформления секции, не больше 16.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities

Тип: array · Уровень: section

Проверка: maxItems=16; uniqueItems=true

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities

/layout/regions/<область>/sections/*/utilities/*Один класс SIMAI Framework.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities/*

Тип: string · Уровень: section

Проверка: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities/items

/layout/scrollbarВид полос прокрутки в меню и оглавлении.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar

/layout/scrollbar/preset
обязательное
overlay — тонкая, появляется при прокрутке; persistent — видна всегда; standard — как в системе; hidden — скрыта.
По умолчанию: наследуется, иначе "overlay"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["overlay","persistent","standard","hidden"]

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar/properties/preset

/settingsВнешний вид: цветовая тема, размытие фона под окнами, скругление углов.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/settings

/settings/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/$reset

/settings/modal_blurРазмытие страницы под окнами поиска и настроек: none, small, medium, large.
По умолчанию: наследуется, иначе "none"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["none","small","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/modal_blur

/settings/themeТема при первом открытии: system — как в системе, light — светлая, dark — тёмная. Читатель может её сменить.
По умолчанию: наследуется, иначе "system"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["system","light","dark"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/theme

/settings/ui_radiusСкругление углов элементов интерфейса: default, medium, large.
По умолчанию: наследуется, иначе "default"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["default","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/ui_radius

Меню, чтение и поиск

ПолеЧто задаёт
/header_navigationСсылки в верхнем меню шапки, не больше 8.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false; allOf=1

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation

/header_navigation/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/$reset

/header_navigation/enabledПоказывать ли верхнее меню. При true нужен список items.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/enabled

/header_navigation/enabled
обязательное
Условие проверки: при enabled: true список items обязателен.
По умолчанию: наследуется
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/allOf/0/if/properties/enabled

/header_navigation/itemsСсылки верхнего меню, от 1 до 8. Список заменяет унаследованный целиком.
По умолчанию: наследуется
Технические данные

Тип: array · Уровень: section

Проверка: minItems=1; maxItems=8

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items

/header_navigation/items/*Одна ссылка: id, label и href.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items

/header_navigation/items/*/href
обязательное
Куда ведёт ссылка: #якорь, путь сайта от / или адрес https://.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: section

Проверка: pattern="^(?:#(?!$)|/(?!/)|https://)[^\\x{0000}-\\x{0020}\\\"'<>\\\\]+$"; maxLength=2000

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/href

/header_navigation/items/*/id
обязательное
Постоянный идентификатор ссылки.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: section

Проверка: pattern="^[a-z][a-z0-9_.-]{0,63}$"

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/id

/header_navigation/items/*/label
обязательное
Текст ссылки, до 80 символов.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: section

Проверка: minLength=1; maxLength=80

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/label

/navigationКак страница или раздел участвуют в меню слева.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/navigation

/navigation/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/$reset

/navigation/hiddenСкрыть из меню. Страница остаётся доступной по адресу.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/hidden

/navigation/orderПорядок в меню среди соседей: меньше — выше. Без номера пункт идёт после пронумерованных.
По умолчанию: после пронумерованных, по имени файла
Технические данные

Тип: integer · Уровень: section

Проверка: minimum=0; maximum=2147483647

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/order

/navigation/scopeЧто показывает меню слева: site — всё дерево, section — только текущий раздел верхнего уровня.
По умолчанию: наследуется, иначе "site"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["site","section"]

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/scope

/readingПомощь при чтении: путь до страницы, оглавление, ссылки «назад» и «вперёд».
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/reading

/reading/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/$reset

/reading/breadcrumbsПоказывать путь от главной до текущей страницы над статьёй.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/breadcrumbs

/reading/mobile_tocКнопка оглавления на телефоне: auto — когда заголовков много, always — всегда, never — никогда.
По умолчанию: наследуется, иначе "auto"
Технические данные

Тип: string · Уровень: section

Проверка: enum=["auto","always","never"]

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/mobile_toc

/reading/previous_nextПоказывать ссылки на предыдущую и следующую страницу в конце статьи.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/previous_next

/reading/tocПоказывать оглавление «На этой странице».
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc

/reading/toc_depthДо какого уровня заголовков строить оглавление, от 2 до 6.
По умолчанию: наследуется, иначе 3
Технические данные

Тип: integer · Уровень: section

Проверка: minimum=2; maximum=6

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc_depth

/searchПоиск по сайту.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/search

/search/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/$reset

/search/enabledПоказывать поиск по сайту.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/enabled

/search/indexedВключать страницу в поиск. false не закрывает доступ к странице.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/indexed

Примеры и код

ПолеЧто задаёт
/codeНастройки обычных блоков кода.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/code

/code/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/code/properties/$reset

/code/wrapПоказывать кнопку переноса длинных строк в блоках кода.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/code/properties/wrap

/examplesНастройки живых примеров :::example.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: section

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/examples

/examples/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: section

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/$reset

/examples/fullscreenПоказывать кнопку проверки примера на разной ширине экрана.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/fullscreen

/examples/wrapПоказывать кнопку переноса длинных строк в исходном коде примера.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: section

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/wrap

page.json

Основное

ПолеЧто задаёт
/descriptionКраткое описание страницы для поисковых систем, соцсетей и результатов поиска по сайту.
По умолчанию: первый абзац страницы
Технические данные

Тип: string · Уровень: page

Проверка: schema type only

Схема: resources/schemas/page.schema.json#/properties/description

/localeЯзык страницы. Должен совпадать с языком каталога, в котором лежит файл; иначе сборка остановится.
По умолчанию: язык каталога страницы
Технические данные

Тип: string · Уровень: page

Проверка: format="docara-bcp47"

Схема: resources/schemas/page.schema.json#/properties/locale

/presetТип страницы: docs — страница документации с меню слева, landing — лендинг без меню документации.
Технические данные

Тип: string · Уровень: page

Проверка: enum=["docs","landing"]

Схема: resources/schemas/page.schema.json#/properties/preset

/schema
обязательное
Тип файла. Всегда docara.page.v1.
Технические данные

Тип: string · Уровень: page

Проверка: const="docara.page.v1"

Схема: resources/schemas/page.schema.json#/properties/schema

/slugСвой адрес страницы вместо пути к файлу: полный путь от корня языка, например guides/install.
По умолчанию: путь к файлу без расширения
Технические данные

Тип: string · Уровень: page

Проверка: pattern="^[a-z0-9](?:[a-z0-9._-]*[a-z0-9_-])?(?:/[a-z0-9](?:[a-z0-9._-]*[a-z0-9_-])?)*$"

Схема: resources/schemas/page.schema.json#/properties/slug

/titleНазвание страницы в меню и в заголовке вкладки, если в Markdown нет заголовка # и title в front matter.
По умолчанию: первый заголовок # страницы
Технические данные

Тип: string · Уровень: page

Проверка: minLength=1

Схема: resources/schemas/page.schema.json#/properties/title

/versionВерсия формата файла. Допустимо только 1.
Технические данные

Тип: integer · Уровень: page

Проверка: const=1

Схема: resources/schemas/page.schema.json#/properties/version

Внешний вид

ПолеЧто задаёт
/brandingБренд в шапке сайта: название, подпись, логотип, значок вкладки и картинка для соцсетей.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/branding

/branding/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/$reset

/branding/creditПодпись «Сделано на Docara» внизу меню. Задаётся только в docara.json.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/credit

/branding/faviconЗначок сайта во вкладке браузера.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: page

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/favicon

/branding/labelКороткая подпись рядом с названием, например «Документация».
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: page

Проверка: minLength=1

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/label

/branding/logoФайл логотипа для шапки, путь от корня проекта.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: page

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo

/branding/logo_darkЛоготип для тёмной темы. Нужен основной logo.
По умолчанию: основной logo
Технические данные

Тип: string · Уровень: page

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo_dark

/branding/modeЧто показать: full — логотип, название и подпись; compact — логотип и название; logo — только логотип; text — только текст.
По умолчанию: наследуется, иначе "full"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["full","compact","logo","text"]

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/mode

/branding/share_imageКартинка для превью ссылки в соцсетях: PNG, JPEG или WebP. Работает только с site_url.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: page

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/share_image

/branding/sizeРазмер логотипа и названия: small, medium или large.
По умолчанию: наследуется, иначе "medium"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["small","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/size

/branding/titleНазвание бренда в шапке. Добавляется к заголовку вкладки браузера.
По умолчанию: title сайта
Технические данные

Тип: string · Уровень: page

Проверка: minLength=1

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/title

/layoutМакет страницы: ширина, отступы, полосы прокрутки и области.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout

/layout/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/$reset

/layout/containerШирина страницы.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/container

/layout/container/max
обязательное
Максимальная ширина страницы по шкале SIMAI Framework, от 1 до 8.
По умолчанию: наследуется, иначе 7
Технические данные

Тип: integer · Уровень: page

Проверка: minimum=1; maximum=8

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/container/properties/max

/layout/contentРасстояние между блоками статьи.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/content

/layout/content/gap
обязательное
Отступ между соседними блоками статьи, от 0 до 8. 0 — обычный поток текста.
По умолчанию: наследуется, иначе null
Технические данные

Тип: integer · Уровень: page

Проверка: minimum=0; maximum=8

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/content/properties/gap

/layout/keyКакой макет использовать. В Docara есть docara.docs.
По умолчанию: наследуется, иначе "docara.docs"
Технические данные

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/key

/layout/regionsОбласти макета: шапка, меню, основная часть, оглавление, подвал.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/regions

/layout/regions/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/regions/properties/$reset

/layout/regions/<область>Настройки одной области: включена ли она и что в ней.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region

/layout/regions/<область>/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/$reset

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/$reset

/layout/regions/<область>/enabledВключает или выключает область. Основную часть main выключить нельзя.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/enabled

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/enabled

/layout/regions/<область>/sectionsСекции области по порядку, не больше 8. Список заменяет унаследованный целиком.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections

Тип: array · Уровень: page

Проверка: maxItems=8

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/sections

/layout/regions/<область>/sections/*Одна секция области.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*

Тип: object · Уровень: page

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region_section

/layout/regions/<область>/sections/*/blocksБлоки секции, от 1 до 12. Только для секций, которые принимают свои блоки.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks

Тип: array · Уровень: page

Проверка: minItems=1; maxItems=12

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/blocks

/layout/regions/<область>/sections/*/blocks/*Один блок секции: простой элемент с текстом или Smart-компонент.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*

Тип: oneOf · Уровень: page

Проверка: oneOf=2

Схема: resources/schemas/presentation.schema.json#/$defs/region_block

/layout/regions/<область>/sections/*/blocks/*/bindДанные сайта, которые получает Smart-компонент, например docara.navigation.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/bind

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9-]*\\.[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/bind

/layout/regions/<область>/sections/*/blocks/*/block
обязательное
Тип блока для простого элемента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/block

/layout/regions/<область>/sections/*/blocks/*/block
обязательное
Тип блока для Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/block

/layout/regions/<область>/sections/*/blocks/*/element
обязательное
Элемент: тег, текст и, при необходимости, ссылка, подпись и классы.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element

Тип: object · Уровень: page

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element

/layout/regions/<область>/sections/*/blocks/*/element/aria_labelПодпись элемента для программ экранного доступа.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/aria_label

Тип: string · Уровень: page

Проверка: minLength=1; maxLength=160

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/aria_label

/layout/regions/<область>/sections/*/blocks/*/element/hrefСсылка внутри сайта для тега a: путь от / или #якорь.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/href

Тип: string · Уровень: page

Проверка: pattern="^(?:/|[/#][^\\u0000-\\u0020\\\"'<>\\\\]+)$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/href

/layout/regions/<область>/sections/*/blocks/*/element/tag
обязательное
HTML-тег элемента: div, p, span или a.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/tag

Тип: string · Уровень: page

Проверка: enum=["div","p","span","a"]

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/tag

/layout/regions/<область>/sections/*/blocks/*/element/text
обязательное
Текст элемента без HTML, до 500 символов.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/text

Тип: string · Уровень: page

Проверка: minLength=1; maxLength=500

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/text

/layout/regions/<область>/sections/*/blocks/*/element/utilitiesКлассы SIMAI Framework для элемента, не больше 16.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities

Тип: array · Уровень: page

Проверка: maxItems=16; uniqueItems=true

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities

/layout/regions/<область>/sections/*/blocks/*/element/utilities/*Один класс SIMAI Framework.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities/*

Тип: string · Уровень: page

Проверка: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities/items

/layout/regions/<область>/sections/*/blocks/*/id
обязательное
Постоянный идентификатор блока внутри секции.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/id

/layout/regions/<область>/sections/*/blocks/*/id
обязательное
Постоянный идентификатор блока внутри секции.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/id

/layout/regions/<область>/sections/*/blocks/*/props
обязательное
Параметры Smart-компонента, не больше 32.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/props

Тип: object · Уровень: page

Проверка: maxProperties=32

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/props

/layout/regions/<область>/sections/*/blocks/*/slot
обязательное
Место внутри секции, куда ставится блок.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/slot

/layout/regions/<область>/sections/*/blocks/*/slot
обязательное
Место внутри секции, куда ставится блок.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/slot

/layout/regions/<область>/sections/*/blocks/*/smart
обязательное
Имя Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/smart

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/smart

/layout/regions/<область>/sections/*/blocks/*/viewВариант отображения Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/view

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/view

/layout/regions/<область>/sections/*/id
обязательное
Постоянный идентификатор секции внутри области.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/id

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/id

/layout/regions/<область>/sections/*/section
обязательное
Тип секции, например docara.navigation или docara.shell.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/section

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/section

/layout/regions/<область>/sections/*/utilitiesКлассы SIMAI Framework для оформления секции, не больше 16.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities

Тип: array · Уровень: page

Проверка: maxItems=16; uniqueItems=true

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities

/layout/regions/<область>/sections/*/utilities/*Один класс SIMAI Framework.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities/*

Тип: string · Уровень: page

Проверка: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities/items

/layout/scrollbarВид полос прокрутки в меню и оглавлении.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar

/layout/scrollbar/preset
обязательное
overlay — тонкая, появляется при прокрутке; persistent — видна всегда; standard — как в системе; hidden — скрыта.
По умолчанию: наследуется, иначе "overlay"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["overlay","persistent","standard","hidden"]

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar/properties/preset

/settingsВнешний вид: цветовая тема, размытие фона под окнами, скругление углов.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/settings

/settings/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/$reset

/settings/modal_blurРазмытие страницы под окнами поиска и настроек: none, small, medium, large.
По умолчанию: наследуется, иначе "none"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["none","small","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/modal_blur

/settings/themeТема при первом открытии: system — как в системе, light — светлая, dark — тёмная. Читатель может её сменить.
По умолчанию: наследуется, иначе "system"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["system","light","dark"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/theme

/settings/ui_radiusСкругление углов элементов интерфейса: default, medium, large.
По умолчанию: наследуется, иначе "default"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["default","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/ui_radius

Меню, чтение и поиск

ПолеЧто задаёт
/header_navigationСсылки в верхнем меню шапки, не больше 8.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false; allOf=1

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation

/header_navigation/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/$reset

/header_navigation/enabledПоказывать ли верхнее меню. При true нужен список items.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/enabled

/header_navigation/enabled
обязательное
Условие проверки: при enabled: true список items обязателен.
По умолчанию: наследуется
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/allOf/0/if/properties/enabled

/header_navigation/itemsСсылки верхнего меню, от 1 до 8. Список заменяет унаследованный целиком.
По умолчанию: наследуется
Технические данные

Тип: array · Уровень: page

Проверка: minItems=1; maxItems=8

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items

/header_navigation/items/*Одна ссылка: id, label и href.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items

/header_navigation/items/*/href
обязательное
Куда ведёт ссылка: #якорь, путь сайта от / или адрес https://.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: page

Проверка: pattern="^(?:#(?!$)|/(?!/)|https://)[^\\x{0000}-\\x{0020}\\\"'<>\\\\]+$"; maxLength=2000

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/href

/header_navigation/items/*/id
обязательное
Постоянный идентификатор ссылки.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: page

Проверка: pattern="^[a-z][a-z0-9_.-]{0,63}$"

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/id

/header_navigation/items/*/label
обязательное
Текст ссылки, до 80 символов.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: page

Проверка: minLength=1; maxLength=80

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/label

/navigationКак страница или раздел участвуют в меню слева.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/navigation

/navigation/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/$reset

/navigation/hiddenСкрыть из меню. Страница остаётся доступной по адресу.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/hidden

/navigation/orderПорядок в меню среди соседей: меньше — выше. Без номера пункт идёт после пронумерованных.
По умолчанию: после пронумерованных, по имени файла
Технические данные

Тип: integer · Уровень: page

Проверка: minimum=0; maximum=2147483647

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/order

/navigation/scopeЧто показывает меню слева: site — всё дерево, section — только текущий раздел верхнего уровня.
По умолчанию: наследуется, иначе "site"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["site","section"]

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/scope

/readingПомощь при чтении: путь до страницы, оглавление, ссылки «назад» и «вперёд».
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/reading

/reading/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/$reset

/reading/breadcrumbsПоказывать путь от главной до текущей страницы над статьёй.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/breadcrumbs

/reading/mobile_tocКнопка оглавления на телефоне: auto — когда заголовков много, always — всегда, never — никогда.
По умолчанию: наследуется, иначе "auto"
Технические данные

Тип: string · Уровень: page

Проверка: enum=["auto","always","never"]

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/mobile_toc

/reading/previous_nextПоказывать ссылки на предыдущую и следующую страницу в конце статьи.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/previous_next

/reading/tocПоказывать оглавление «На этой странице».
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc

/reading/toc_depthДо какого уровня заголовков строить оглавление, от 2 до 6.
По умолчанию: наследуется, иначе 3
Технические данные

Тип: integer · Уровень: page

Проверка: minimum=2; maximum=6

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc_depth

/searchПоиск по сайту.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/search

/search/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/$reset

/search/enabledПоказывать поиск по сайту.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/enabled

/search/indexedВключать страницу в поиск. false не закрывает доступ к странице.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/indexed

Примеры и код

ПолеЧто задаёт
/codeНастройки обычных блоков кода.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/code

/code/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/code/properties/$reset

/code/wrapПоказывать кнопку переноса длинных строк в блоках кода.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/code/properties/wrap

/examplesНастройки живых примеров :::example.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: page

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/examples

/examples/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: page

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/$reset

/examples/fullscreenПоказывать кнопку проверки примера на разной ширине экрана.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/fullscreen

/examples/wrapПоказывать кнопку переноса длинных строк в исходном коде примера.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: page

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/wrap

Общие поля оформления

Эти ветки одинаковы на всех трёх уровнях. Таблица строится из presentation.schema.json.

ПолеЧто задаёт
/brandingБренд в шапке сайта: название, подпись, логотип, значок вкладки и картинка для соцсетей.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/branding

/branding/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/$reset

/branding/creditПодпись «Сделано на Docara» внизу меню. Задаётся только в docara.json.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/credit

/branding/faviconЗначок сайта во вкладке браузера.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: shared

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/favicon

/branding/labelКороткая подпись рядом с названием, например «Документация».
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: shared

Проверка: minLength=1

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/label

/branding/logoФайл логотипа для шапки, путь от корня проекта.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: shared

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo

/branding/logo_darkЛоготип для тёмной темы. Нужен основной logo.
По умолчанию: основной logo
Технические данные

Тип: string · Уровень: shared

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo_dark

/branding/modeЧто показать: full — логотип, название и подпись; compact — логотип и название; logo — только логотип; text — только текст.
По умолчанию: наследуется, иначе "full"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["full","compact","logo","text"]

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/mode

/branding/share_imageКартинка для превью ссылки в соцсетях: PNG, JPEG или WebP. Работает только с site_url.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: shared

Проверка: format="docara-relative-path"

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/share_image

/branding/sizeРазмер логотипа и названия: small, medium или large.
По умолчанию: наследуется, иначе "medium"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["small","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/size

/branding/titleНазвание бренда в шапке. Добавляется к заголовку вкладки браузера.
По умолчанию: title сайта
Технические данные

Тип: string · Уровень: shared

Проверка: minLength=1

Схема: resources/schemas/presentation.schema.json#/$defs/branding/properties/title

/codeНастройки обычных блоков кода.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/code

/code/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/code/properties/$reset

/code/wrapПоказывать кнопку переноса длинных строк в блоках кода.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/code/properties/wrap

/examplesНастройки живых примеров :::example.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/examples

/examples/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/$reset

/examples/fullscreenПоказывать кнопку проверки примера на разной ширине экрана.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/fullscreen

/examples/wrapПоказывать кнопку переноса длинных строк в исходном коде примера.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/examples/properties/wrap

/header_navigationСсылки в верхнем меню шапки, не больше 8.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false; allOf=1

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation

/header_navigation/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/$reset

/header_navigation/enabledПоказывать ли верхнее меню. При true нужен список items.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/enabled

/header_navigation/enabled
обязательное
Условие проверки: при enabled: true список items обязателен.
По умолчанию: наследуется
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/allOf/0/if/properties/enabled

/header_navigation/itemsСсылки верхнего меню, от 1 до 8. Список заменяет унаследованный целиком.
По умолчанию: наследуется
Технические данные

Тип: array · Уровень: shared

Проверка: minItems=1; maxItems=8

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items

/header_navigation/items/*Одна ссылка: id, label и href.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items

/header_navigation/items/*/href
обязательное
Куда ведёт ссылка: #якорь, путь сайта от / или адрес https://.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: shared

Проверка: pattern="^(?:#(?!$)|/(?!/)|https://)[^\\x{0000}-\\x{0020}\\\"'<>\\\\]+$"; maxLength=2000

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/href

/header_navigation/items/*/id
обязательное
Постоянный идентификатор ссылки.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]{0,63}$"

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/id

/header_navigation/items/*/label
обязательное
Текст ссылки, до 80 символов.
По умолчанию: наследуется
Технические данные

Тип: string · Уровень: shared

Проверка: minLength=1; maxLength=80

Схема: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/label

/layoutМакет страницы: ширина, отступы, полосы прокрутки и области.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout

/layout/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/$reset

/layout/containerШирина страницы.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/container

/layout/container/max
обязательное
Максимальная ширина страницы по шкале SIMAI Framework, от 1 до 8.
По умолчанию: наследуется, иначе 7
Технические данные

Тип: integer · Уровень: shared

Проверка: minimum=1; maximum=8

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/container/properties/max

/layout/contentРасстояние между блоками статьи.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/content

/layout/content/gap
обязательное
Отступ между соседними блоками статьи, от 0 до 8. 0 — обычный поток текста.
По умолчанию: наследуется, иначе null
Технические данные

Тип: integer · Уровень: shared

Проверка: minimum=0; maximum=8

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/content/properties/gap

/layout/keyКакой макет использовать. В Docara есть docara.docs.
По умолчанию: наследуется, иначе "docara.docs"
Технические данные

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/key

/layout/regionsОбласти макета: шапка, меню, основная часть, оглавление, подвал.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/regions

/layout/regions/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/regions/properties/$reset

/layout/regions/<область>Настройки одной области: включена ли она и что в ней.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region

/layout/regions/<область>/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/$reset

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/$reset

/layout/regions/<область>/enabledВключает или выключает область. Основную часть main выключить нельзя.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/enabled

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/enabled

/layout/regions/<область>/sectionsСекции области по порядку, не больше 8. Список заменяет унаследованный целиком.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections

Тип: array · Уровень: shared

Проверка: maxItems=8

Схема: resources/schemas/presentation.schema.json#/$defs/region/properties/sections

/layout/regions/<область>/sections/*Одна секция области.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*

Тип: object · Уровень: shared

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region_section

/layout/regions/<область>/sections/*/blocksБлоки секции, от 1 до 12. Только для секций, которые принимают свои блоки.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks

Тип: array · Уровень: shared

Проверка: minItems=1; maxItems=12

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/blocks

/layout/regions/<область>/sections/*/blocks/*Один блок секции: простой элемент с текстом или Smart-компонент.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*

Тип: oneOf · Уровень: shared

Проверка: oneOf=2

Схема: resources/schemas/presentation.schema.json#/$defs/region_block

/layout/regions/<область>/sections/*/blocks/*/bindДанные сайта, которые получает Smart-компонент, например docara.navigation.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/bind

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9-]*\\.[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/bind

/layout/regions/<область>/sections/*/blocks/*/block
обязательное
Тип блока для простого элемента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/block

/layout/regions/<область>/sections/*/blocks/*/block
обязательное
Тип блока для Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/block

/layout/regions/<область>/sections/*/blocks/*/element
обязательное
Элемент: тег, текст и, при необходимости, ссылка, подпись и классы.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element

Тип: object · Уровень: shared

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element

/layout/regions/<область>/sections/*/blocks/*/element/aria_labelПодпись элемента для программ экранного доступа.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/aria_label

Тип: string · Уровень: shared

Проверка: minLength=1; maxLength=160

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/aria_label

/layout/regions/<область>/sections/*/blocks/*/element/hrefСсылка внутри сайта для тега a: путь от / или #якорь.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/href

Тип: string · Уровень: shared

Проверка: pattern="^(?:/|[/#][^\\u0000-\\u0020\\\"'<>\\\\]+)$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/href

/layout/regions/<область>/sections/*/blocks/*/element/tag
обязательное
HTML-тег элемента: div, p, span или a.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/tag

Тип: string · Уровень: shared

Проверка: enum=["div","p","span","a"]

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/tag

/layout/regions/<область>/sections/*/blocks/*/element/text
обязательное
Текст элемента без HTML, до 500 символов.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/text

Тип: string · Уровень: shared

Проверка: minLength=1; maxLength=500

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/text

/layout/regions/<область>/sections/*/blocks/*/element/utilitiesКлассы SIMAI Framework для элемента, не больше 16.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities

Тип: array · Уровень: shared

Проверка: maxItems=16; uniqueItems=true

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities

/layout/regions/<область>/sections/*/blocks/*/element/utilities/*Один класс SIMAI Framework.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities/*

Тип: string · Уровень: shared

Проверка: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities/items

/layout/regions/<область>/sections/*/blocks/*/id
обязательное
Постоянный идентификатор блока внутри секции.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/id

/layout/regions/<область>/sections/*/blocks/*/id
обязательное
Постоянный идентификатор блока внутри секции.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/id

/layout/regions/<область>/sections/*/blocks/*/props
обязательное
Параметры Smart-компонента, не больше 32.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/props

Тип: object · Уровень: shared

Проверка: maxProperties=32

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/props

/layout/regions/<область>/sections/*/blocks/*/slot
обязательное
Место внутри секции, куда ставится блок.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/slot

/layout/regions/<область>/sections/*/blocks/*/slot
обязательное
Место внутри секции, куда ставится блок.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/slot

/layout/regions/<область>/sections/*/blocks/*/smart
обязательное
Имя Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/smart

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/smart

/layout/regions/<область>/sections/*/blocks/*/viewВариант отображения Smart-компонента.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/view

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/view

/layout/regions/<область>/sections/*/id
обязательное
Постоянный идентификатор секции внутри области.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/id

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/id

/layout/regions/<область>/sections/*/section
обязательное
Тип секции, например docara.navigation или docara.shell.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/section

Тип: string · Уровень: shared

Проверка: pattern="^[a-z][a-z0-9_.-]+$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/section

/layout/regions/<область>/sections/*/utilitiesКлассы SIMAI Framework для оформления секции, не больше 16.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities

Тип: array · Уровень: shared

Проверка: maxItems=16; uniqueItems=true

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities

/layout/regions/<область>/sections/*/utilities/*Один класс SIMAI Framework.
По умолчанию: наследуется
Технические данные

Путь: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities/*

Тип: string · Уровень: shared

Проверка: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Схема: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities/items

/layout/scrollbarВид полос прокрутки в меню и оглавлении.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar

/layout/scrollbar/preset
обязательное
overlay — тонкая, появляется при прокрутке; persistent — видна всегда; standard — как в системе; hidden — скрыта.
По умолчанию: наследуется, иначе "overlay"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["overlay","persistent","standard","hidden"]

Схема: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar/properties/preset

/navigationКак страница или раздел участвуют в меню слева.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/navigation

/navigation/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/$reset

/navigation/hiddenСкрыть из меню. Страница остаётся доступной по адресу.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/hidden

/navigation/orderПорядок в меню среди соседей: меньше — выше. Без номера пункт идёт после пронумерованных.
По умолчанию: после пронумерованных, по имени файла
Технические данные

Тип: integer · Уровень: shared

Проверка: minimum=0; maximum=2147483647

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/order

/navigation/scopeЧто показывает меню слева: site — всё дерево, section — только текущий раздел верхнего уровня.
По умолчанию: наследуется, иначе "site"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["site","section"]

Схема: resources/schemas/presentation.schema.json#/$defs/navigation/properties/scope

/readingПомощь при чтении: путь до страницы, оглавление, ссылки «назад» и «вперёд».
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/reading

/reading/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/$reset

/reading/breadcrumbsПоказывать путь от главной до текущей страницы над статьёй.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/breadcrumbs

/reading/mobile_tocКнопка оглавления на телефоне: auto — когда заголовков много, always — всегда, never — никогда.
По умолчанию: наследуется, иначе "auto"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["auto","always","never"]

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/mobile_toc

/reading/previous_nextПоказывать ссылки на предыдущую и следующую страницу в конце статьи.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/previous_next

/reading/tocПоказывать оглавление «На этой странице».
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc

/reading/toc_depthДо какого уровня заголовков строить оглавление, от 2 до 6.
По умолчанию: наследуется, иначе 3
Технические данные

Тип: integer · Уровень: shared

Проверка: minimum=2; maximum=6

Схема: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc_depth

/searchПоиск по сайту.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/search

/search/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/$reset

/search/enabledПоказывать поиск по сайту.
По умолчанию: наследуется, иначе false
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/enabled

/search/indexedВключать страницу в поиск. false не закрывает доступ к странице.
По умолчанию: наследуется, иначе true
Технические данные

Тип: boolean · Уровень: shared

Проверка: schema type only

Схема: resources/schemas/presentation.schema.json#/$defs/search/properties/indexed

/settingsВнешний вид: цветовая тема, размытие фона под окнами, скругление углов.
По умолчанию: наследуется
Технические данные

Тип: object · Уровень: shared

Проверка: minProperties=1; additionalProperties=false

Схема: resources/schemas/presentation.schema.json#/$defs/settings

/settings/$resetСбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.
Технические данные

Тип: bool · Уровень: shared

Проверка: const=true

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/$reset

/settings/modal_blurРазмытие страницы под окнами поиска и настроек: none, small, medium, large.
По умолчанию: наследуется, иначе "none"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["none","small","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/modal_blur

/settings/themeТема при первом открытии: system — как в системе, light — светлая, dark — тёмная. Читатель может её сменить.
По умолчанию: наследуется, иначе "system"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["system","light","dark"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/theme

/settings/ui_radiusСкругление углов элементов интерфейса: default, medium, large.
По умолчанию: наследуется, иначе "default"
Технические данные

Тип: string · Уровень: shared

Проверка: enum=["default","medium","large"]

Схема: resources/schemas/presentation.schema.json#/$defs/settings/properties/ui_radius

Метаданные Markdown

Блок метаданных (front matter) в начале Markdown-страницы принимает только ключи title, description, tags, draft, noindex, translation_key, profile и composition_recipe. Что делает каждый ключ, описано в разделе «Markdown».

Поиск по документации

Введите минимум 2 символа

    Настройки

    Тема
    Размер шрифта
    Ширина страницы