К содержанию

Навигация

Блоки лендинга

Из этих блоков собирают продуктовую страницу: главная этого сайта сделана из них, первого экрана и раскрывающихся вопросов. Блоки пишутся обычным Markdown внутри :::имя и :::. Параметров у них нет: вид определяется содержимым, а ширину, отступы и тему задаёт SIMAI Framework.

Блок Для чего
features Две–шесть карточек: значок или картинка, заголовок и короткий текст
showcase Заголовок, пояснение, действие и большой скриншот результата
promo Финальный блок страницы с одним действием
columns Две–четыре колонки текста рядом
cta Одна заметная кнопка-ссылка

Первый экран описан на странице Первый экран, а раскрывающиеся вопросы — на странице Раскрывающийся блок. Как собрана главная, рассказано на странице Как собрана главная страница.

Features: карточки преимуществ

Блок превращает маркированный список в сетку карточек. В списке от двух до шести пунктов, в каждом — один абзац. Пункт может начинаться со значка :icon[...] или картинки: они встают над текстом карточки. Жирный текст в начале пункта становится заголовком карточки.

  • Быстро.Сборка выдаёт готовые HTML, CSS и JavaScript.
  • Поиск.Индекс работает в браузере читателя без сервера.
  • Языки.Каждый язык — своя папка с Markdown.

Значок, записанный не первым, остаётся обычным значком внутри текста. Вместо значка можно поставить картинку: - ![](../../assets/feature-json.png) **JSON.** Текст. Картинка в карточке декоративная, поэтому её alt можно оставить пустым.

Showcase: показать результат

Блок показывает результат крупно: заголовок второго уровня, один или два абзаца описания, необязательная ссылка-действие и одна картинка последней строкой. У картинки обязательно описание (alt), потому что она несёт смысл. На широком экране текст стоит рядом с картинкой, на узком — над ней.

Посмотрите на результат до публикации

Docara собирает интерфейс документации из Markdown, JSON и проверенных компонентов.

Открыть быстрый старт
Страница документации Docara

Promo: финальный призыв

Блок закрывает страницу: заголовок второго уровня, один или два абзаца и ровно одна ссылка-действие. Картинка последней строкой необязательна. Блок выделен приглушённым фоном. На главной этого сайта promo стоит в самом конце и ведёт в быстрый старт.

Соберите первый сайт

Быстрый старт проведёт от пустого каталога до готовой страницы в браузере.

Перейти к быстрому старту

Один источник для сайта и документации

Markdown и JSON превращаются в проверенный статический сайт.

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

Columns: колонки

Блок ставит рядом от двух до четырёх частей текста. Части разделяются отдельной строкой --- с пустыми строками до и после. На узком экране колонки встают друг под другом в том же порядке.

Markdown

Содержимое остаётся читаемым исходным текстом.

JSON

Настройки наследуются и проверяются схемами.

PHP

Для сборки не нужен Node.js.

Внутри колонки можно писать обычный Markdown: абзацы, списки, ссылки. Пустая колонка останавливает сборку.

CTA: кнопка действия

Блок показывает одну ссылку как заметную кнопку. В нём ровно одна ссылка с текстом.

Если действий несколько, используйте кнопки-ссылки в абзаце или showcase со ссылками.

Ограничения

  • Блоки не вкладываются друг в друга и в другие блоки Docara. Исключение — columns, внутри которых можно писать обычный Markdown.
  • Блок начинается строкой :::имя без отступа и заканчивается строкой :::.
  • Ссылки и картинки — только https:// или пути внутри сайта.
  • Нарушение правил останавливает сборку с понятным кодом, например MARKDOWN_FEATURES_ITEM_COUNT_INVALID или MARKDOWN_CTA_LINK_REQUIRED. Все коды с причинами и исправлениями — в справочнике ошибок страниц.

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

Введите минимум 2 символа

    Настройки

    Тема
    Размер шрифта
    Ширина страницы