К содержанию

Главное

Страница по шаблону с выбором шапки

Шаблон страницы описывает её части, а одна настройка выбирает, какую шапку поставить: краткую или расширенную. Обе страницы ниже собраны из одних и тех же файлов шаблона, отличаются только значением настройки.

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

Краткая шапка

Расширенная шапка

Как это устроено

  1. recipe.json — шаблон: в шапку ставится фрагмент по значению headerMode, в основную часть — текст из значения body.
  2. Файл значений задаёт headerMode: compact или expanded. Остальное у двух страниц общее.
  3. Шапки — отдельные файлы. В краткой только заголовок. В расширенной над заголовком строка о разделе и версии API, под ним — сводка: запрос, срок и событие, которое придёт по итогу.
  4. Страница Docara ссылается на свой набор файлов строкой composition_recipe в начале Markdown. SIMAI Framework собирает страницу при сборке сайта, в браузере ничего не вычисляется.
compact.md
---title: "Страница по шаблону: краткая шапка"description: Страница Docara, собранная Framework из файлового шаблона, содержимого и настройки.composition_recipe: composition/descriptor-compact.jsonnoindex: true---

Что можно поменять

Параметр Что меняет
headerMode Вариант шапки: compact или expanded
composition_recipe Какой набор файлов шаблона собирает страницу

См. также