docara.json

docara.json — файл настроек всего сайта. Только здесь задаются корень контента, базовый и публичный адрес, реестр языков и правила адресов, версия документации, файл перенаправлений, панель читателя, Framework lock и пространство имён Smart-компонентов проекта. Поля оформления, меню и чтения, заданные здесь, служат значениями по умолчанию для всех страниц.

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

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

Поля оформления, меню и чтения также можно задать в section.json и <page>.page.json: см. section.json и page.json. Как работают уровни и наследование, описано в разделе «Сайт, раздел и страница».

Основное

Поле	Что задаёт
`/content_root`	Каталог с Markdown для сайта на одном языке. Если заданы `locales`, используется каталог каждого языка. По умолчанию: `"content"` Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/site.schema.json#/properties/content_root`
`/documentation_version`	Метка версии документации. Записывается в каждую страницу. По умолчанию: `"current"` Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[A-Za-z0-9](?:[A-Za-z0-9._-]{0,62}[A-Za-z0-9])?$"` Схема: `resources/schemas/site.schema.json#/properties/documentation_version`
`/framework_lock` обязательное	Путь к файлу, который закрепляет версию SIMAI Framework, например `simai-framework.lock.json`. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/site.schema.json#/properties/framework_lock`
`/preset` обязательное	Тип страниц по умолчанию для всего сайта: `docs` или `landing`. Раздел и страница могут его поменять. Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["docs","landing"]` Схема: `resources/schemas/site.schema.json#/properties/preset`
`/schema` обязательное	Тип файла. Всегда `docara.site.v1`. Технические данные Тип: `string` · Уровень: `site` Проверка: `const="docara.site.v1"` Схема: `resources/schemas/site.schema.json#/properties/schema`
`/title`	Название сайта. Используется как название бренда в шапке и в `llms.txt`. По умолчанию: `"Docara"` Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/site.schema.json#/properties/title`
`/version`	Версия формата файла. Допустимо только `1`. Технические данные Тип: `integer` · Уровень: `site` Проверка: `const=1` Схема: `resources/schemas/site.schema.json#/properties/version`

Адрес и публикация

Подробнее — в разделе «Адрес сайта и поисковые системы».

Поле	Что задаёт
`/base_url`	Путь, по которому сайт открывается на сервере, например `/docs/`. Должен совпадать с путём в `site_url`. По умолчанию: `"/"` Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^(?:/\|/(?!\\.{1,2}(?:/\|$))[A-Za-z0-9._~-]+(?:/(?!\\.{1,2}(?:/\|$))[A-Za-z0-9._~-]+)*/?)$"` Схема: `resources/schemas/site.schema.json#/properties/base_url`
`/discovery`	Что сказать о сайте в `llms.txt`. Работает только с `site_url`. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/discovery`
`/discovery/description`	Краткое описание сайта в начале `llms.txt`. По умолчанию: описание главной страницы основного языка Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/site.schema.json#/properties/discovery/properties/description`
`/discovery/llms_links`	Дополнительные ссылки в `llms.txt`, не больше 32. По умолчанию: `[]` Технические данные Тип: `array` · Уровень: `site` Проверка: `maxItems=32` Схема: `resources/schemas/site.schema.json#/properties/discovery/properties/llms_links`
`/discovery/llms_links/*`	Одна ссылка: название, путь и описание. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items`
`/discovery/llms_links/*/description`	Короткое пояснение после ссылки. Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items/properties/description`
`/discovery/llms_links/*/path` обязательное	Путь к файлу или странице относительно `base_url`. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[A-Za-z0-9._~-]+(?:/[A-Za-z0-9._~-]+)*/?$"` Схема: `resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items/properties/path`
`/discovery/llms_links/*/title` обязательное	Текст ссылки. Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items/properties/title`
`/not_found`	Страница `404.html` для несуществующих адресов. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/not_found`
`/not_found/enabled` обязательное	Создавать ли `404.html`. Текст берётся из `404.md` основного языка или из строк `error.not_found.*`. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/site.schema.json#/properties/not_found/properties/enabled`
`/page_transforms`	Команды, которые обрабатывают собранный сайт до проверки, не больше 8. По умолчанию: `[]` Технические данные Тип: `array` · Уровень: `site` Проверка: `maxItems=8` Схема: `resources/schemas/site.schema.json#/properties/page_transforms`
`/page_transforms/*`	Одна команда обработки. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/page_transforms/items`
`/page_transforms/*/command` обязательное	Программа и её аргументы списком. Последним аргументом добавляется каталог собранного сайта. Технические данные Тип: `array` · Уровень: `site` Проверка: `minItems=1; maxItems=16` Схема: `resources/schemas/site.schema.json#/properties/page_transforms/items/properties/command`
`/page_transforms//command/`	Один аргумент команды. Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/site.schema.json#/properties/page_transforms/items/properties/command/items`
`/portal`	Сборка сайта как раздела портала, например `/ru/docara/docs/` на `https://simai.io/`. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/portal`
`/portal/home_label`	Текст ссылки на главную страницу портала. По умолчанию: имя сервера из `home_url` Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1; maxLength=80` Схема: `resources/schemas/site.schema.json#/properties/portal/properties/home_label`
`/portal/home_url` обязательное	Адрес главной страницы портала для ссылки в шапке. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^https://[A-Za-z0-9](?:[A-Za-z0-9.-][A-Za-z0-9])?(?::[0-9]{1,5})?(?:/[A-Za-z0-9._~%-])*$"` Схема: `resources/schemas/site.schema.json#/properties/portal/properties/home_url`
`/portal/product` обязательное	Идентификатор продукта на портале. Даёт имя архиву для публикации. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[a-z][a-z0-9-]{1,63}$"` Схема: `resources/schemas/site.schema.json#/properties/portal/properties/product`
`/redirects_file`	Файл с перенаправлениями со старых адресов, например `redirects.json`. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/site.schema.json#/properties/redirects_file`
`/site_url`	Полный публичный адрес сайта, например `https://example.com/docs/`. С ним сборка создаёт `sitemap.xml`, `robots.txt` и `llms.txt`. По умолчанию: не задан: без `sitemap.xml`, `robots.txt` и `llms.txt` Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^https?://[A-Za-z0-9.-]+(?::[0-9]{1,5})?(?:/\|/[A-Za-z0-9._~-]+(?:/[A-Za-z0-9._~-]+)*/?)$"` Схема: `resources/schemas/site.schema.json#/properties/site_url`

Языки и переводы

Подробнее — в разделе Локали и маршрутизация.

Поле	Что задаёт
`/default_locale`	Основной язык сайта. Должен быть в `locales`. По умолчанию: первый язык в `locales` Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-bcp47"` Схема: `resources/schemas/site.schema.json#/properties/default_locale`
`/locale`	Язык сайта без списка `locales`. Устаревший способ: лучше задать `default_locale` и `locales`. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-bcp47"` Схема: `resources/schemas/site.schema.json#/properties/locale`
`/locale_routing`	Как строятся адреса языков и что открывается в корне сайта. По умолчанию: `{"strategy":"default_unprefixed","root":"default_locale","detect_browser_language":false,"legacy_unprefixed_redirects":false}` Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/$defs/localeRouting`
`/locale_routing/detect_browser_language` обязательное	Зарезервировано. Значение проверяется, но сейчас ни на что не влияет. Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/site.schema.json#/$defs/localeRouting/properties/detect_browser_language`
`/locale_routing/legacy_unprefixed_redirects`	Создаёт перенаправления со старых адресов без префикса на адреса основного языка. Только при `strategy: prefixed`. Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/site.schema.json#/$defs/localeRouting/properties/legacy_unprefixed_redirects`
`/locale_routing/root` обязательное	Что открывается в корне сайта: `default_locale` — главная основного языка, `redirect` — перенаправление на неё. Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["default_locale","redirect"]` Схема: `resources/schemas/site.schema.json#/$defs/localeRouting/properties/root`
`/locale_routing/strategy` обязательное	Схема адресов: `default_unprefixed` — основной язык без префикса, остальные с префиксом; `prefixed` — у каждого языка свой префикс. Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["default_unprefixed","prefixed"]` Схема: `resources/schemas/site.schema.json#/$defs/localeRouting/properties/strategy`
`/locales`	Языки сайта. Ключ — код языка, например `ru` или `en`. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/locales`
`/locales/<язык>`	Настройки одного языка: название, направление текста, каталог, префикс адреса и запасные языки. Технические данные Путь: `/locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>` Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/$defs/locale`
`/locales/<язык>/content_root` обязательное	Каталог с Markdown этого языка, например `content/ru`. Технические данные Путь: `/locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/content_root` Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/site.schema.json#/$defs/locale/properties/content_root`
`/locales/<язык>/direction` обязательное	Направление текста: `ltr` — слева направо, `rtl` — справа налево. Технические данные Путь: `/locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/direction` Тип: `string` · Уровень: `site` Проверка: `enum=["ltr","rtl"]` Схема: `resources/schemas/site.schema.json#/$defs/locale/properties/direction`
`/locales/<язык>/fallbacks`	Языки, из которых берутся строки интерфейса (`lang.json`), если их нет у этого языка. По умолчанию: `[]` Технические данные Путь: `/locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/fallbacks` Тип: `array` · Уровень: `site` Проверка: `uniqueItems=true` Схема: `resources/schemas/site.schema.json#/$defs/locale/properties/fallbacks`
`/locales/<язык>/fallbacks/*`	Код одного запасного языка. Технические данные Путь: `/locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})$>/fallbacks/` Тип: `string` · Уровень: `site` Проверка: `format="docara-bcp47"` Схема: `resources/schemas/site.schema.json#/$defs/locale/properties/fallbacks/items`
`/locales/<язык>/label` обязательное	Название языка в переключателе языков. Технические данные Путь: `/locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/label` Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/site.schema.json#/$defs/locale/properties/label`
`/locales/<язык>/public_prefix`	Префикс адреса страниц языка, например `ru` даёт `/ru/...`. Пустая строка — язык открывается от корня сайта. По умолчанию: код языка Технические данные Путь: `/locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})$>/public_prefix` Тип: `string` · Уровень: `site` Проверка: `pattern="^(?:\|[A-Za-z0-9](?:[A-Za-z0-9._~-][A-Za-z0-9])?)$"` Схема: `resources/schemas/site.schema.json#/$defs/locale/properties/public_prefix`
`/locales/missing_page_policy`	Что делать, если страница есть на одном языке и нет на другом: `skip` — не публиковать её на этом языке, `error` — остановить сборку. По умолчанию: `"skip"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["skip","error"]` Схема: `resources/schemas/site.schema.json#/properties/locales/properties/missing_page_policy`
`/translation_tracking`	Отслеживание переводов: какие страницы и строки переведены, устарели или ещё не проверены. По умолчанию: выключено Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/$defs/translationTracking`
`/translation_tracking/enabled` обязательное	Включает отслеживание переводов. Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/site.schema.json#/$defs/translationTracking/properties/enabled`
`/translation_tracking/lock_file` обязательное	Файл в корне проекта, где хранятся принятые переводы, например `translations.lock.json`. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[A-Za-z0-9][A-Za-z0-9._-]*\\.json$"` Схема: `resources/schemas/site.schema.json#/$defs/translationTracking/properties/lock_file`
`/translation_tracking/mode` обязательное	`report` — только отчёт о состоянии переводов; `publish-current` — публиковать перевод, только пока он актуален, иначе показывать оригинал. Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["report","publish-current"]` Схема: `resources/schemas/site.schema.json#/$defs/translationTracking/properties/mode`
`/translation_tracking/source_locale` обязательное	Язык оригинала, с которым сравниваются переводы. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-bcp47"` Схема: `resources/schemas/site.schema.json#/$defs/translationTracking/properties/source_locale`

Внешний вид

Подробнее — в разделах «Бренд и тема» и «Области макета».

Поле	Что задаёт
`/branding`	Бренд в шапке сайта: название, подпись, логотип, значок вкладки и картинка для соцсетей. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/branding`
`/branding/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/$reset`
`/branding/credit`	Подпись «Сделано на Docara» внизу меню. Задаётся только в `docara.json`. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/credit`
`/branding/favicon`	Значок сайта во вкладке браузера. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/favicon`
`/branding/label`	Короткая подпись рядом с названием, например «Документация». Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/label`
`/branding/logo`	Файл логотипа для шапки, путь от корня проекта. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/logo`
`/branding/logo_dark`	Логотип для тёмной темы. Нужен основной `logo`. По умолчанию: основной `logo` Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/logo_dark`
`/branding/mode`	Что показать: `full` — логотип, название и подпись; `compact` — логотип и название; `logo` — только логотип; `text` — только текст. По умолчанию: `"full"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["full","compact","logo","text"]` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/mode`
`/branding/share_image`	Картинка для превью ссылки в соцсетях: PNG, JPEG или WebP. Работает только с `site_url`. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/share_image`
`/branding/size`	Размер логотипа и названия: `small`, `medium` или `large`. По умолчанию: `"medium"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["small","medium","large"]` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/size`
`/branding/title`	Название бренда в шапке. Добавляется к заголовку вкладки браузера. По умолчанию: `title` сайта Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/presentation.schema.json#/$defs/branding/properties/title`
`/effects`	Каталог фоновых анимаций SIMAI Framework для блока hero. По умолчанию: эффекты недоступны Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/effects`
`/effects/catalogue` обязательное	Адрес каталога эффектов `https://...`, закреплённый на конкретном коммите и заканчивающийся на `/`. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^https://[A-Za-z0-9](?:[A-Za-z0-9.-][A-Za-z0-9])?(?::[0-9]{1,5})?/(?:[A-Za-z0-9._~%@+-]+/)$"` Схема: `resources/schemas/site.schema.json#/properties/effects/properties/catalogue`
`/effects/index`	Путь к файлу со списком эффектов внутри каталога. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[A-Za-z0-9._-]+(?:/[A-Za-z0-9._-]+)*\\.json$"` Схема: `resources/schemas/site.schema.json#/properties/effects/properties/index`
`/effects/index_sha256`	Контрольная сумма SHA-256 файла со списком эффектов, если его нужно проверять. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[0-9a-f]{64}$"` Схема: `resources/schemas/site.schema.json#/properties/effects/properties/index_sha256`
`/layout`	Макет страницы: ширина, отступы, полосы прокрутки и области. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/layout`
`/layout/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/$reset`
`/layout/container`	Ширина страницы. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/container`
`/layout/container/max` обязательное	Максимальная ширина страницы по шкале SIMAI Framework, от 1 до 8. По умолчанию: `7` Технические данные Тип: `integer` · Уровень: `site` Проверка: `minimum=1; maximum=8` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/container/properties/max`
`/layout/content`	Расстояние между блоками статьи. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/content`
`/layout/content/gap` обязательное	Отступ между соседними блоками статьи, от 0 до 8. `0` — обычный поток текста. По умолчанию: `null` Технические данные Тип: `integer` · Уровень: `site` Проверка: `minimum=0; maximum=8` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/content/properties/gap`
`/layout/key`	Какой макет использовать. В Docara есть `docara.docs`. По умолчанию: `"docara.docs"` Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[a-z][a-z0-9_.-]+$"` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/key`
`/layout/regions`	Области макета: шапка, меню, основная часть, оглавление, подвал. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/regions`
`/layout/regions/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/regions/properties/$reset`
`/layout/regions/<область>`	Настройки одной области: включена ли она и что в ней. Технические данные Путь: `/layout/regions/<^[a-z][a-z0-9_.-]+$>` Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/region`
`/layout/regions/<область>/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Путь: `/layout/regions/<^[a-z][a-z0-9_.-]+$>/$reset` Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/region/properties/$reset`
`/layout/regions/<область>/enabled`	Включает или выключает область. Основную часть `main` выключить нельзя. Технические данные Путь: `/layout/regions/<^[a-z][a-z0-9_.-]+$>/enabled` Тип: `boolean` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `maxItems=8` Схема: `resources/schemas/presentation.schema.json#/$defs/region/properties/sections`
`/layout/regions/<область>/sections/*`	Одна секция области. Технические данные Путь: `/layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*` Тип: `object` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `pattern="^[a-z0-9][a-z0-9_:/.-]*$"` Схема: `resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities/items`
`/layout/scrollbar`	Вид полос прокрутки в меню и оглавлении. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar`
`/layout/scrollbar/preset` обязательное	`overlay` — тонкая, появляется при прокрутке; `persistent` — видна всегда; `standard` — как в системе; `hidden` — скрыта. По умолчанию: `"overlay"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["overlay","persistent","standard","hidden"]` Схема: `resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar/properties/preset`
`/settings`	Внешний вид: цветовая тема, размытие фона под окнами, скругление углов. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/settings`
`/settings/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/settings/properties/$reset`
`/settings/modal_blur`	Размытие страницы под окнами поиска и настроек: `none`, `small`, `medium`, `large`. По умолчанию: `"none"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["none","small","medium","large"]` Схема: `resources/schemas/presentation.schema.json#/$defs/settings/properties/modal_blur`
`/settings/theme`	Тема при первом открытии: `system` — как в системе, `light` — светлая, `dark` — тёмная. Читатель может её сменить. По умолчанию: `"system"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["system","light","dark"]` Схема: `resources/schemas/presentation.schema.json#/$defs/settings/properties/theme`
`/settings/ui_radius`	Скругление углов элементов интерфейса: `default`, `medium`, `large`. По умолчанию: `"default"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["default","medium","large"]` Схема: `resources/schemas/presentation.schema.json#/$defs/settings/properties/ui_radius`
`/theme`	Цвета сайта, построенные из одного основного цвета. По умолчанию: цвета SIMAI Framework Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/properties/theme`
`/theme/chroma`	Необязательная поправка насыщенности, от 0 до 150. Технические данные Тип: `integer` · Уровень: `site` Проверка: `minimum=0; maximum=150` Схема: `resources/schemas/site.schema.json#/properties/theme/properties/chroma`
`/theme/color` обязательное	Основной цвет сайта в виде `#rgb` или `#rrggbb`. Технические данные Тип: `string` · Уровень: `site` Проверка: `minLength=1` Схема: `resources/schemas/site.schema.json#/properties/theme/properties/color`
`/theme/hue`	Необязательная поправка оттенка, от 0 до 360. Технические данные Тип: `integer` · Уровень: `site` Проверка: `minimum=0; maximum=360` Схема: `resources/schemas/site.schema.json#/properties/theme/properties/hue`

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

Подробнее — в разделах «Меню и разделы», «Контекст чтения», «Поиск» и «Панель читателя».

Поле	Что задаёт
`/header_navigation`	Ссылки в верхнем меню шапки, не больше 8. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false; allOf=1` Схема: `resources/schemas/presentation.schema.json#/$defs/header_navigation`
`/header_navigation/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/$reset`
`/header_navigation/enabled`	Показывать ли верхнее меню. При `true` нужен список `items`. По умолчанию: `false` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/enabled`
`/header_navigation/enabled` обязательное	Условие проверки: при `enabled: true` список `items` обязателен. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/header_navigation/allOf/0/if/properties/enabled`
`/header_navigation/items`	Ссылки верхнего меню, от 1 до 8. Список заменяет унаследованный целиком. Технические данные Тип: `array` · Уровень: `site` Проверка: `minItems=1; maxItems=8` Схема: `resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items`
`/header_navigation/items/*`	Одна ссылка: `id`, `label` и `href`. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items`
`/header_navigation/items/*/href` обязательное	Куда ведёт ссылка: `#якорь`, путь сайта от `/` или адрес `https://`. Технические данные Тип: `string` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `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` · Уровень: `site` Проверка: `minLength=1; maxLength=80` Схема: `resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/label`
`/navigation`	Как страница или раздел участвуют в меню слева. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/navigation`
`/navigation/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/navigation/properties/$reset`
`/navigation/hidden`	Скрыть из меню. Страница остаётся доступной по адресу. По умолчанию: `false` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/navigation/properties/hidden`
`/navigation/order`	Порядок в меню среди соседей: меньше — выше. Без номера пункт идёт после пронумерованных. По умолчанию: после пронумерованных, по имени файла Технические данные Тип: `integer` · Уровень: `site` Проверка: `minimum=0; maximum=2147483647` Схема: `resources/schemas/presentation.schema.json#/$defs/navigation/properties/order`
`/navigation/scope`	Что показывает меню слева: `site` — всё дерево, `section` — только текущий раздел верхнего уровня. По умолчанию: `"site"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["site","section"]` Схема: `resources/schemas/presentation.schema.json#/$defs/navigation/properties/scope`
`/reader_preferences`	Панель настроек читателя: тема, размер шрифта, ширина страницы. Выбор хранится в браузере читателя. По умолчанию: `{"enabled":true,"view":"side-panel","groups":[{"id":"appearance","fields":["appearance.theme","appearance.font_size","appearance.content_width"]}]}` Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences`
`/reader_preferences/enabled` обязательное	Показывает или скрывает панель настроек читателя. Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/enabled`
`/reader_preferences/groups` обязательное	Группы настроек в панели в порядке показа. Технические данные Тип: `array` · Уровень: `site` Проверка: `maxItems=20; uniqueItems=true` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups`
`/reader_preferences/groups/*`	Одна группа: имя и список настроек. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items`
`/reader_preferences/groups/*/fields` обязательное	Настройки группы: `appearance.theme`, `appearance.font_size`, `appearance.content_width`. Технические данные Тип: `array` · Уровень: `site` Проверка: `minItems=1; maxItems=50; uniqueItems=true` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items/properties/fields`
`/reader_preferences/groups//fields/`	Имя одной настройки. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[a-z][a-z0-9](?:[._-][a-z0-9]+)$"; maxLength=120` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items/properties/fields/items`
`/reader_preferences/groups/*/id` обязательное	Имя группы, например `appearance`. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[a-z][a-z0-9](?:[._-][a-z0-9]+)$"; maxLength=80` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items/properties/id`
`/reader_preferences/hidden_fields`	Стандартные настройки, которые нужно убрать из панели. По умолчанию: `[]` Технические данные Тип: `array` · Уровень: `site` Проверка: `maxItems=50; uniqueItems=true` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/hidden_fields`
`/reader_preferences/hidden_fields/*`	Имя одной скрытой настройки. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[a-z][a-z0-9](?:[._-][a-z0-9]+)$"; maxLength=120` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/hidden_fields/items`
`/reader_preferences/view` обязательное	Вид панели. Сейчас только `side-panel` — боковая панель. Технические данные Тип: `string` · Уровень: `site` Проверка: `const="side-panel"` Схема: `resources/schemas/site.schema.json#/$defs/readerPreferences/properties/view`
`/reading`	Помощь при чтении: путь до страницы, оглавление, ссылки «назад» и «вперёд». Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/reading`
`/reading/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/reading/properties/$reset`
`/reading/breadcrumbs`	Показывать путь от главной до текущей страницы над статьёй. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/reading/properties/breadcrumbs`
`/reading/mobile_toc`	Кнопка оглавления на телефоне: `auto` — когда заголовков много, `always` — всегда, `never` — никогда. По умолчанию: `"auto"` Технические данные Тип: `string` · Уровень: `site` Проверка: `enum=["auto","always","never"]` Схема: `resources/schemas/presentation.schema.json#/$defs/reading/properties/mobile_toc`
`/reading/previous_next`	Показывать ссылки на предыдущую и следующую страницу в конце статьи. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/reading/properties/previous_next`
`/reading/toc`	Показывать оглавление «На этой странице». По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/reading/properties/toc`
`/reading/toc_depth`	До какого уровня заголовков строить оглавление, от 2 до 6. По умолчанию: `3` Технические данные Тип: `integer` · Уровень: `site` Проверка: `minimum=2; maximum=6` Схема: `resources/schemas/presentation.schema.json#/$defs/reading/properties/toc_depth`
`/search`	Поиск по сайту. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/search`
`/search/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/search/properties/$reset`
`/search/enabled`	Показывать поиск по сайту. По умолчанию: `false` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/search/properties/enabled`
`/search/indexed`	Включать страницу в поиск. `false` не закрывает доступ к странице. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/search/properties/indexed`

Примеры, код и расширения

Поле	Что задаёт
`/code`	Настройки обычных блоков кода. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/code`
`/code/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/code/properties/$reset`
`/code/wrap`	Показывать кнопку переноса длинных строк в блоках кода. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/code/properties/wrap`
`/documentation_tracking`	Проверка, что справочные страницы и примеры соответствуют текущему коду проекта. По умолчанию: выключено Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/$defs/documentationTracking`
`/documentation_tracking/enabled` обязательное	Включает проверку актуальности документации. Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/site.schema.json#/$defs/documentationTracking/properties/enabled`
`/documentation_tracking/lock_file` обязательное	Файл в корне проекта, где хранится принятое состояние документации, например `documentation.lock.json`. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[A-Za-z0-9][A-Za-z0-9._-]*\\.json$"` Схема: `resources/schemas/site.schema.json#/$defs/documentationTracking/properties/lock_file`
`/documentation_tracking/mode` обязательное	Режим проверки. Сейчас только `report`: отчёт без влияния на публикацию. Технические данные Тип: `string` · Уровень: `site` Проверка: `const="report"` Схема: `resources/schemas/site.schema.json#/$defs/documentationTracking/properties/mode`
`/documentation_tracking/source_locale` обязательное	Язык страниц, которые сравниваются с кодом. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-bcp47"` Схема: `resources/schemas/site.schema.json#/$defs/documentationTracking/properties/source_locale`
`/documentation_tracking/sources` обязательное	Источники описания кода, с которыми сравнивается документация. Нужен хотя бы один. Технические данные Тип: `array` · Уровень: `site` Проверка: `minItems=1` Схема: `resources/schemas/site.schema.json#/$defs/documentationTracking/properties/sources`
`/documentation_tracking/sources/*`	Один источник описания кода: SIMAI Framework или собственный JSON-файл проекта. Технические данные Тип: `oneOf` · Уровень: `site` Проверка: `oneOf=2` Схема: `resources/schemas/site.schema.json#/$defs/documentationSource`
`/documentation_tracking/sources/*/file` обязательное	Путь к JSON-файлу с описанием кода. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/1/properties/file`
`/documentation_tracking/sources/*/framework_lock` обязательное	Путь к файлу закрепления SIMAI Framework, из которого берётся описание. Технические данные Тип: `string` · Уровень: `site` Проверка: `format="docara-relative-path"` Схема: `resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/0/properties/framework_lock`
`/documentation_tracking/sources/*/id` обязательное	Уникальное имя источника. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[a-z][a-z0-9-]*$"` Схема: `resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/0/properties/id`
`/documentation_tracking/sources/*/id` обязательное	Уникальное имя источника. Должно совпадать с `id` внутри файла. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^[a-z][a-z0-9-]*$"` Схема: `resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/1/properties/id`
`/documentation_tracking/sources/*/provider` обязательное	`simai_framework` — описание Core, утилит и компонентов из закреплённой версии SIMAI Framework. Технические данные Тип: `string` · Уровень: `site` Проверка: `const="simai_framework"` Схема: `resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/0/properties/provider`
`/documentation_tracking/sources/*/provider` обязательное	`contract_json` — собственный JSON-файл проекта с описанием кода. Технические данные Тип: `string` · Уровень: `site` Проверка: `const="contract_json"` Схема: `resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/1/properties/provider`
`/examples`	Настройки живых примеров `:::example`. Технические данные Тип: `object` · Уровень: `site` Проверка: `minProperties=1; additionalProperties=false` Схема: `resources/schemas/presentation.schema.json#/$defs/examples`
`/examples/$reset`	Сбрасывает унаследованные значения этой группы: дальше действуют только поля, заданные рядом. Технические данные Тип: `bool` · Уровень: `site` Проверка: `const=true` Схема: `resources/schemas/presentation.schema.json#/$defs/examples/properties/$reset`
`/examples/fullscreen`	Показывать кнопку проверки примера на разной ширине экрана. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/examples/properties/fullscreen`
`/examples/wrap`	Показывать кнопку переноса длинных строк в исходном коде примера. По умолчанию: `true` Технические данные Тип: `boolean` · Уровень: `site` Проверка: `schema type only` Схема: `resources/schemas/presentation.schema.json#/$defs/examples/properties/wrap`
`/smart`	Подключает собственные Smart-компоненты проекта из каталога `smart/`. Технические данные Тип: `object` · Уровень: `site` Проверка: `additionalProperties=false` Схема: `resources/schemas/site.schema.json#/$defs/projectSmart`
`/smart/namespace` обязательное	Префикс имён собственных Smart-компонентов. Нельзя `ui` и `docara`. Технические данные Тип: `string` · Уровень: `site` Проверка: `pattern="^(?!ui$\|docara$)[a-z][a-z0-9-]*$"` Схема: `resources/schemas/site.schema.json#/$defs/projectSmart/properties/namespace`

Навигация

Главное

Документация

Содержание

docara.json

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

Основное

Адрес и публикация

Языки и переводы

Внешний вид

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

Примеры, код и расширения

Настройки

docara.json

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

Основное

Адрес и публикация

Языки и переводы

Внешний вид

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

Примеры, код и расширения

Поиск по документации