section.json и page.json
section.json настраивает раздел: соседнюю страницу-обзор и все страницы
каталога. <page>.page.json уточняет одну страницу и дополнительно задаёт её
description и slug. Как уровни наследуются и сбрасываются, описано в
разделе «Сайт, раздел и страница».
Как читать таблицы полей
Таблицы строятся при сборке из JSON Schema. Если поле не задано в файле,
действует значение уровнем выше: из ближайшего section.json родительского
каталога или из docara.json. Строка «По умолчанию» под описанием показывает
встроенное значение Docara, если поле не задано нигде. В «Технических данных» —
тип, правило проверки и место в схеме.
section.json
Основное
| Поле | Что задаёт |
|---|---|
/locale | Язык раздела. Должен совпадать с языком каталога; иначе сборка остановится. По умолчанию: язык каталога раздела Технические данныеТип: Проверка: Схема: |
/preset | Тип всех страниц раздела: docs или landing.Технические данныеТип: Проверка: Схема: |
/schemaобязательное | Тип файла. Всегда docara.section.v1.Технические данныеТип: Проверка: Схема: |
/title | Название раздела (каталога) в меню слева. По умолчанию: имя каталога Технические данныеТип: Проверка: Схема: |
/version | Версия формата файла. Допустимо только 1.Технические данныеТип: Проверка: Схема: |
Внешний вид
| Поле | Что задаёт |
|---|---|
/branding | Бренд в шапке сайта: название, подпись, логотип, значок вкладки и картинка для соцсетей. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/branding/credit | Подпись «Сделано на Docara» внизу меню. Задаётся только в docara.json.По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/branding/favicon | Значок сайта во вкладке браузера. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/label | Короткая подпись рядом с названием, например «Документация». По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/logo | Файл логотипа для шапки, путь от корня проекта. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/logo_dark | Логотип для тёмной темы. Нужен основной logo.По умолчанию: основной logoТехнические данныеТип: Проверка: Схема: |
/branding/mode | Что показать: full — логотип, название и подпись; compact — логотип и название; logo — только логотип; text — только текст.По умолчанию: наследуется, иначе "full"Технические данныеТип: Проверка: Схема: |
/branding/share_image | Картинка для превью ссылки в соцсетях: PNG, JPEG или WebP. Работает только с site_url.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/size | Размер логотипа и названия: small, medium или large.По умолчанию: наследуется, иначе "medium"Технические данныеТип: Проверка: Схема: |
/branding/title | Название бренда в шапке. Добавляется к заголовку вкладки браузера. По умолчанию: title сайтаТехнические данныеТип: Проверка: Схема: |
/layout | Макет страницы: ширина, отступы, полосы прокрутки и области. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/layout/container | Ширина страницы. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/container/maxобязательное | Максимальная ширина страницы по шкале SIMAI Framework, от 1 до 8. По умолчанию: наследуется, иначе 7Технические данныеТип: Проверка: Схема: |
/layout/content | Расстояние между блоками статьи. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/content/gapобязательное | Отступ между соседними блоками статьи, от 0 до 8. 0 — обычный поток текста.По умолчанию: наследуется, иначе nullТехнические данныеТип: Проверка: Схема: |
/layout/key | Какой макет использовать. В Docara есть docara.docs.По умолчанию: наследуется, иначе "docara.docs"Технические данныеТип: Проверка: Схема: |
/layout/regions | Области макета: шапка, меню, основная часть, оглавление, подвал. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/regions/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/layout/regions/<область> | Настройки одной области: включена ли она и что в ней. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/enabled | Включает или выключает область. Основную часть main выключить нельзя.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections | Секции области по порядку, не больше 8. Список заменяет унаследованный целиком. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/* | Одна секция области. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks | Блоки секции, от 1 до 12. Только для секций, которые принимают свои блоки. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/* | Один блок секции: простой элемент с текстом или Smart-компонент. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/bind | Данные сайта, которые получает Smart-компонент, например docara.navigation.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/blockобязательное | Тип блока для простого элемента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/blockобязательное | Тип блока для Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/elementобязательное | Элемент: тег, текст и, при необходимости, ссылка, подпись и классы. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/aria_label | Подпись элемента для программ экранного доступа. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/href | Ссылка внутри сайта для тега a: путь от / или #якорь.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/tagобязательное | HTML-тег элемента: div, p, span или a.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/textобязательное | Текст элемента без HTML, до 500 символов. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/utilities | Классы SIMAI Framework для элемента, не больше 16. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/utilities/* | Один класс SIMAI Framework. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/idобязательное | Постоянный идентификатор блока внутри секции. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/idобязательное | Постоянный идентификатор блока внутри секции. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/propsобязательное | Параметры Smart-компонента, не больше 32. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/slotобязательное | Место внутри секции, куда ставится блок. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/slotобязательное | Место внутри секции, куда ставится блок. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/smartобязательное | Имя Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/view | Вариант отображения Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/idобязательное | Постоянный идентификатор секции внутри области. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/sectionобязательное | Тип секции, например docara.navigation или docara.shell.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/utilities | Классы SIMAI Framework для оформления секции, не больше 16. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/utilities/* | Один класс SIMAI Framework. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/scrollbar | Вид полос прокрутки в меню и оглавлении. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/scrollbar/presetобязательное | overlay — тонкая, появляется при прокрутке; persistent — видна всегда; standard — как в системе; hidden — скрыта.По умолчанию: наследуется, иначе "overlay"Технические данныеТип: Проверка: Схема: |
/settings | Внешний вид: цветовая тема, размытие фона под окнами, скругление углов. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/settings/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/settings/modal_blur | Размытие страницы под окнами поиска и настроек: none, small, medium, large.По умолчанию: наследуется, иначе "none"Технические данныеТип: Проверка: Схема: |
/settings/theme | Тема при первом открытии: system — как в системе, light — светлая, dark — тёмная. Читатель может её сменить.По умолчанию: наследуется, иначе "system"Технические данныеТип: Проверка: Схема: |
/settings/ui_radius | Скругление углов элементов интерфейса: default, medium, large.По умолчанию: наследуется, иначе "default"Технические данныеТип: Проверка: Схема: |
Меню, чтение и поиск
| Поле | Что задаёт |
|---|---|
/header_navigation | Ссылки в верхнем меню шапки, не больше 8. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/header_navigation/enabled | Показывать ли верхнее меню. При true нужен список items.По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/header_navigation/enabledобязательное | Условие проверки: при enabled: true список items обязателен.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items | Ссылки верхнего меню, от 1 до 8. Список заменяет унаследованный целиком. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/* | Одна ссылка: id, label и href.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/hrefобязательное | Куда ведёт ссылка: #якорь, путь сайта от / или адрес https://.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/idобязательное | Постоянный идентификатор ссылки. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/labelобязательное | Текст ссылки, до 80 символов. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/navigation | Как страница или раздел участвуют в меню слева. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/navigation/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/navigation/hidden | Скрыть из меню. Страница остаётся доступной по адресу. По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/navigation/order | Порядок в меню среди соседей: меньше — выше. Без номера пункт идёт после пронумерованных. По умолчанию: после пронумерованных, по имени файла Технические данныеТип: Проверка: Схема: |
/navigation/scope | Что показывает меню слева: site — всё дерево, section — только текущий раздел верхнего уровня.По умолчанию: наследуется, иначе "site"Технические данныеТип: Проверка: Схема: |
/reading | Помощь при чтении: путь до страницы, оглавление, ссылки «назад» и «вперёд». По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/reading/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/reading/breadcrumbs | Показывать путь от главной до текущей страницы над статьёй. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/mobile_toc | Кнопка оглавления на телефоне: auto — когда заголовков много, always — всегда, never — никогда.По умолчанию: наследуется, иначе "auto"Технические данныеТип: Проверка: Схема: |
/reading/previous_next | Показывать ссылки на предыдущую и следующую страницу в конце статьи. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/toc | Показывать оглавление «На этой странице». По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/toc_depth | До какого уровня заголовков строить оглавление, от 2 до 6. По умолчанию: наследуется, иначе 3Технические данныеТип: Проверка: Схема: |
/search | Поиск по сайту. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/search/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/search/enabled | Показывать поиск по сайту. По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/search/indexed | Включать страницу в поиск. false не закрывает доступ к странице.По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
Примеры и код
| Поле | Что задаёт |
|---|---|
/code | Настройки обычных блоков кода. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/code/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/code/wrap | Показывать кнопку переноса длинных строк в блоках кода. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/examples | Настройки живых примеров :::example.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/examples/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/examples/fullscreen | Показывать кнопку проверки примера на разной ширине экрана. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/examples/wrap | Показывать кнопку переноса длинных строк в исходном коде примера. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
page.json
Основное
| Поле | Что задаёт |
|---|---|
/description | Краткое описание страницы для поисковых систем, соцсетей и результатов поиска по сайту. По умолчанию: первый абзац страницы Технические данныеТип: Проверка: Схема: |
/locale | Язык страницы. Должен совпадать с языком каталога, в котором лежит файл; иначе сборка остановится. По умолчанию: язык каталога страницы Технические данныеТип: Проверка: Схема: |
/preset | Тип страницы: docs — страница документации с меню слева, landing — лендинг без меню документации.Технические данныеТип: Проверка: Схема: |
/schemaобязательное | Тип файла. Всегда docara.page.v1.Технические данныеТип: Проверка: Схема: |
/slug | Свой адрес страницы вместо пути к файлу: полный путь от корня языка, например guides/install.По умолчанию: путь к файлу без расширения Технические данныеТип: Проверка: Схема: |
/title | Название страницы в меню и в заголовке вкладки, если в Markdown нет заголовка # и title в front matter.По умолчанию: первый заголовок # страницыТехнические данныеТип: Проверка: Схема: |
/version | Версия формата файла. Допустимо только 1.Технические данныеТип: Проверка: Схема: |
Внешний вид
| Поле | Что задаёт |
|---|---|
/branding | Бренд в шапке сайта: название, подпись, логотип, значок вкладки и картинка для соцсетей. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/branding/credit | Подпись «Сделано на Docara» внизу меню. Задаётся только в docara.json.По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/branding/favicon | Значок сайта во вкладке браузера. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/label | Короткая подпись рядом с названием, например «Документация». По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/logo | Файл логотипа для шапки, путь от корня проекта. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/logo_dark | Логотип для тёмной темы. Нужен основной logo.По умолчанию: основной logoТехнические данныеТип: Проверка: Схема: |
/branding/mode | Что показать: full — логотип, название и подпись; compact — логотип и название; logo — только логотип; text — только текст.По умолчанию: наследуется, иначе "full"Технические данныеТип: Проверка: Схема: |
/branding/share_image | Картинка для превью ссылки в соцсетях: PNG, JPEG или WebP. Работает только с site_url.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/size | Размер логотипа и названия: small, medium или large.По умолчанию: наследуется, иначе "medium"Технические данныеТип: Проверка: Схема: |
/branding/title | Название бренда в шапке. Добавляется к заголовку вкладки браузера. По умолчанию: title сайтаТехнические данныеТип: Проверка: Схема: |
/layout | Макет страницы: ширина, отступы, полосы прокрутки и области. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/layout/container | Ширина страницы. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/container/maxобязательное | Максимальная ширина страницы по шкале SIMAI Framework, от 1 до 8. По умолчанию: наследуется, иначе 7Технические данныеТип: Проверка: Схема: |
/layout/content | Расстояние между блоками статьи. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/content/gapобязательное | Отступ между соседними блоками статьи, от 0 до 8. 0 — обычный поток текста.По умолчанию: наследуется, иначе nullТехнические данныеТип: Проверка: Схема: |
/layout/key | Какой макет использовать. В Docara есть docara.docs.По умолчанию: наследуется, иначе "docara.docs"Технические данныеТип: Проверка: Схема: |
/layout/regions | Области макета: шапка, меню, основная часть, оглавление, подвал. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/regions/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/layout/regions/<область> | Настройки одной области: включена ли она и что в ней. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/enabled | Включает или выключает область. Основную часть main выключить нельзя.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections | Секции области по порядку, не больше 8. Список заменяет унаследованный целиком. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/* | Одна секция области. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks | Блоки секции, от 1 до 12. Только для секций, которые принимают свои блоки. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/* | Один блок секции: простой элемент с текстом или Smart-компонент. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/bind | Данные сайта, которые получает Smart-компонент, например docara.navigation.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/blockобязательное | Тип блока для простого элемента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/blockобязательное | Тип блока для Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/elementобязательное | Элемент: тег, текст и, при необходимости, ссылка, подпись и классы. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/aria_label | Подпись элемента для программ экранного доступа. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/href | Ссылка внутри сайта для тега a: путь от / или #якорь.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/tagобязательное | HTML-тег элемента: div, p, span или a.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/textобязательное | Текст элемента без HTML, до 500 символов. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/utilities | Классы SIMAI Framework для элемента, не больше 16. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/utilities/* | Один класс SIMAI Framework. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/idобязательное | Постоянный идентификатор блока внутри секции. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/idобязательное | Постоянный идентификатор блока внутри секции. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/propsобязательное | Параметры Smart-компонента, не больше 32. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/slotобязательное | Место внутри секции, куда ставится блок. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/slotобязательное | Место внутри секции, куда ставится блок. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/smartобязательное | Имя Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/view | Вариант отображения Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/idобязательное | Постоянный идентификатор секции внутри области. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/sectionобязательное | Тип секции, например docara.navigation или docara.shell.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/utilities | Классы SIMAI Framework для оформления секции, не больше 16. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/utilities/* | Один класс SIMAI Framework. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/scrollbar | Вид полос прокрутки в меню и оглавлении. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/scrollbar/presetобязательное | overlay — тонкая, появляется при прокрутке; persistent — видна всегда; standard — как в системе; hidden — скрыта.По умолчанию: наследуется, иначе "overlay"Технические данныеТип: Проверка: Схема: |
/settings | Внешний вид: цветовая тема, размытие фона под окнами, скругление углов. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/settings/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/settings/modal_blur | Размытие страницы под окнами поиска и настроек: none, small, medium, large.По умолчанию: наследуется, иначе "none"Технические данныеТип: Проверка: Схема: |
/settings/theme | Тема при первом открытии: system — как в системе, light — светлая, dark — тёмная. Читатель может её сменить.По умолчанию: наследуется, иначе "system"Технические данныеТип: Проверка: Схема: |
/settings/ui_radius | Скругление углов элементов интерфейса: default, medium, large.По умолчанию: наследуется, иначе "default"Технические данныеТип: Проверка: Схема: |
Меню, чтение и поиск
| Поле | Что задаёт |
|---|---|
/header_navigation | Ссылки в верхнем меню шапки, не больше 8. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/header_navigation/enabled | Показывать ли верхнее меню. При true нужен список items.По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/header_navigation/enabledобязательное | Условие проверки: при enabled: true список items обязателен.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items | Ссылки верхнего меню, от 1 до 8. Список заменяет унаследованный целиком. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/* | Одна ссылка: id, label и href.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/hrefобязательное | Куда ведёт ссылка: #якорь, путь сайта от / или адрес https://.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/idобязательное | Постоянный идентификатор ссылки. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/labelобязательное | Текст ссылки, до 80 символов. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/navigation | Как страница или раздел участвуют в меню слева. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/navigation/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/navigation/hidden | Скрыть из меню. Страница остаётся доступной по адресу. По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/navigation/order | Порядок в меню среди соседей: меньше — выше. Без номера пункт идёт после пронумерованных. По умолчанию: после пронумерованных, по имени файла Технические данныеТип: Проверка: Схема: |
/navigation/scope | Что показывает меню слева: site — всё дерево, section — только текущий раздел верхнего уровня.По умолчанию: наследуется, иначе "site"Технические данныеТип: Проверка: Схема: |
/reading | Помощь при чтении: путь до страницы, оглавление, ссылки «назад» и «вперёд». По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/reading/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/reading/breadcrumbs | Показывать путь от главной до текущей страницы над статьёй. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/mobile_toc | Кнопка оглавления на телефоне: auto — когда заголовков много, always — всегда, never — никогда.По умолчанию: наследуется, иначе "auto"Технические данныеТип: Проверка: Схема: |
/reading/previous_next | Показывать ссылки на предыдущую и следующую страницу в конце статьи. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/toc | Показывать оглавление «На этой странице». По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/toc_depth | До какого уровня заголовков строить оглавление, от 2 до 6. По умолчанию: наследуется, иначе 3Технические данныеТип: Проверка: Схема: |
/search | Поиск по сайту. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/search/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/search/enabled | Показывать поиск по сайту. По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/search/indexed | Включать страницу в поиск. false не закрывает доступ к странице.По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
Примеры и код
| Поле | Что задаёт |
|---|---|
/code | Настройки обычных блоков кода. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/code/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/code/wrap | Показывать кнопку переноса длинных строк в блоках кода. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/examples | Настройки живых примеров :::example.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/examples/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/examples/fullscreen | Показывать кнопку проверки примера на разной ширине экрана. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/examples/wrap | Показывать кнопку переноса длинных строк в исходном коде примера. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
Общие поля оформления
Эти ветки одинаковы на всех трёх уровнях. Таблица строится из
presentation.schema.json.
| Поле | Что задаёт |
|---|---|
/branding | Бренд в шапке сайта: название, подпись, логотип, значок вкладки и картинка для соцсетей. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/branding/credit | Подпись «Сделано на Docara» внизу меню. Задаётся только в docara.json.По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/branding/favicon | Значок сайта во вкладке браузера. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/label | Короткая подпись рядом с названием, например «Документация». По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/logo | Файл логотипа для шапки, путь от корня проекта. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/logo_dark | Логотип для тёмной темы. Нужен основной logo.По умолчанию: основной logoТехнические данныеТип: Проверка: Схема: |
/branding/mode | Что показать: full — логотип, название и подпись; compact — логотип и название; logo — только логотип; text — только текст.По умолчанию: наследуется, иначе "full"Технические данныеТип: Проверка: Схема: |
/branding/share_image | Картинка для превью ссылки в соцсетях: PNG, JPEG или WebP. Работает только с site_url.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/branding/size | Размер логотипа и названия: small, medium или large.По умолчанию: наследуется, иначе "medium"Технические данныеТип: Проверка: Схема: |
/branding/title | Название бренда в шапке. Добавляется к заголовку вкладки браузера. По умолчанию: title сайтаТехнические данныеТип: Проверка: Схема: |
/code | Настройки обычных блоков кода. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/code/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/code/wrap | Показывать кнопку переноса длинных строк в блоках кода. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/examples | Настройки живых примеров :::example.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/examples/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/examples/fullscreen | Показывать кнопку проверки примера на разной ширине экрана. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/examples/wrap | Показывать кнопку переноса длинных строк в исходном коде примера. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/header_navigation | Ссылки в верхнем меню шапки, не больше 8. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/header_navigation/enabled | Показывать ли верхнее меню. При true нужен список items.По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/header_navigation/enabledобязательное | Условие проверки: при enabled: true список items обязателен.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items | Ссылки верхнего меню, от 1 до 8. Список заменяет унаследованный целиком. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/* | Одна ссылка: id, label и href.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/hrefобязательное | Куда ведёт ссылка: #якорь, путь сайта от / или адрес https://.По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/idобязательное | Постоянный идентификатор ссылки. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/header_navigation/items/*/labelобязательное | Текст ссылки, до 80 символов. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout | Макет страницы: ширина, отступы, полосы прокрутки и области. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/layout/container | Ширина страницы. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/container/maxобязательное | Максимальная ширина страницы по шкале SIMAI Framework, от 1 до 8. По умолчанию: наследуется, иначе 7Технические данныеТип: Проверка: Схема: |
/layout/content | Расстояние между блоками статьи. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/content/gapобязательное | Отступ между соседними блоками статьи, от 0 до 8. 0 — обычный поток текста.По умолчанию: наследуется, иначе nullТехнические данныеТип: Проверка: Схема: |
/layout/key | Какой макет использовать. В Docara есть docara.docs.По умолчанию: наследуется, иначе "docara.docs"Технические данныеТип: Проверка: Схема: |
/layout/regions | Области макета: шапка, меню, основная часть, оглавление, подвал. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/regions/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/layout/regions/<область> | Настройки одной области: включена ли она и что в ней. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/enabled | Включает или выключает область. Основную часть main выключить нельзя.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections | Секции области по порядку, не больше 8. Список заменяет унаследованный целиком. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/* | Одна секция области. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks | Блоки секции, от 1 до 12. Только для секций, которые принимают свои блоки. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/* | Один блок секции: простой элемент с текстом или Smart-компонент. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/bind | Данные сайта, которые получает Smart-компонент, например docara.navigation.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/blockобязательное | Тип блока для простого элемента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/blockобязательное | Тип блока для Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/elementобязательное | Элемент: тег, текст и, при необходимости, ссылка, подпись и классы. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/aria_label | Подпись элемента для программ экранного доступа. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/href | Ссылка внутри сайта для тега a: путь от / или #якорь.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/tagобязательное | HTML-тег элемента: div, p, span или a.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/textобязательное | Текст элемента без HTML, до 500 символов. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/utilities | Классы SIMAI Framework для элемента, не больше 16. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/element/utilities/* | Один класс SIMAI Framework. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/idобязательное | Постоянный идентификатор блока внутри секции. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/idобязательное | Постоянный идентификатор блока внутри секции. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/propsобязательное | Параметры Smart-компонента, не больше 32. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/slotобязательное | Место внутри секции, куда ставится блок. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/slotобязательное | Место внутри секции, куда ставится блок. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/smartобязательное | Имя Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/blocks/*/view | Вариант отображения Smart-компонента. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/idобязательное | Постоянный идентификатор секции внутри области. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/sectionобязательное | Тип секции, например docara.navigation или docara.shell.По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/utilities | Классы SIMAI Framework для оформления секции, не больше 16. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/regions/<область>/sections/*/utilities/* | Один класс SIMAI Framework. По умолчанию: наследуется Технические данныеПуть: Тип: Проверка: Схема: |
/layout/scrollbar | Вид полос прокрутки в меню и оглавлении. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/layout/scrollbar/presetобязательное | overlay — тонкая, появляется при прокрутке; persistent — видна всегда; standard — как в системе; hidden — скрыта.По умолчанию: наследуется, иначе "overlay"Технические данныеТип: Проверка: Схема: |
/navigation | Как страница или раздел участвуют в меню слева. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/navigation/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/navigation/hidden | Скрыть из меню. Страница остаётся доступной по адресу. По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/navigation/order | Порядок в меню среди соседей: меньше — выше. Без номера пункт идёт после пронумерованных. По умолчанию: после пронумерованных, по имени файла Технические данныеТип: Проверка: Схема: |
/navigation/scope | Что показывает меню слева: site — всё дерево, section — только текущий раздел верхнего уровня.По умолчанию: наследуется, иначе "site"Технические данныеТип: Проверка: Схема: |
/reading | Помощь при чтении: путь до страницы, оглавление, ссылки «назад» и «вперёд». По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/reading/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/reading/breadcrumbs | Показывать путь от главной до текущей страницы над статьёй. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/mobile_toc | Кнопка оглавления на телефоне: auto — когда заголовков много, always — всегда, never — никогда.По умолчанию: наследуется, иначе "auto"Технические данныеТип: Проверка: Схема: |
/reading/previous_next | Показывать ссылки на предыдущую и следующую страницу в конце статьи. По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/toc | Показывать оглавление «На этой странице». По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/reading/toc_depth | До какого уровня заголовков строить оглавление, от 2 до 6. По умолчанию: наследуется, иначе 3Технические данныеТип: Проверка: Схема: |
/search | Поиск по сайту. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/search/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/search/enabled | Показывать поиск по сайту. По умолчанию: наследуется, иначе falseТехнические данныеТип: Проверка: Схема: |
/search/indexed | Включать страницу в поиск. false не закрывает доступ к странице.По умолчанию: наследуется, иначе trueТехнические данныеТип: Проверка: Схема: |
/settings | Внешний вид: цветовая тема, размытие фона под окнами, скругление углов. По умолчанию: наследуется Технические данныеТип: Проверка: Схема: |
/settings/$reset | Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом.Технические данныеТип: Проверка: Схема: |
/settings/modal_blur | Размытие страницы под окнами поиска и настроек: none, small, medium, large.По умолчанию: наследуется, иначе "none"Технические данныеТип: Проверка: Схема: |
/settings/theme | Тема при первом открытии: system — как в системе, light — светлая, dark — тёмная. Читатель может её сменить.По умолчанию: наследуется, иначе "system"Технические данныеТип: Проверка: Схема: |
/settings/ui_radius | Скругление углов элементов интерфейса: default, medium, large.По умолчанию: наследуется, иначе "default"Технические данныеТип: Проверка: Схема: |
Метаданные Markdown
Блок метаданных (front matter) в начале Markdown-страницы принимает только
ключи title, description, tags, draft, noindex, translation_key,
profile и composition_recipe. Что делает каждый ключ, описано в разделе
«Markdown».