К содержанию

Навигация

Содержание и макет

В переносимом Docara файлы являются источником истины:

  • Markdown хранит текст и структуру содержания;
  • docara.json задаёт сайт;
  • redirects.json сохраняет обязательные старые внутренние URL;
  • section.json задаёт наследуемые значения ветки;
  • необязательный <page>.page.json уточняет только одну страницу;
  • generator создаёт HTML, indexes и диагностические artifacts.

Простое правило

Начинайте с обычного Markdown. Добавляйте JSON только для представления и навигации. Выбирайте компонент только тогда, когда Markdown недостаточно, и берите точный вызов из справочника компонентов.

Путь автора

  1. Разберитесь с файлами проекта.
  2. Напишите страницу в Markdown.
  3. Настройте сайт, раздел или страницу.
  4. Добавьте название, логотип и favicon.
  5. Проверьте наследование и $reset.
  6. Выберите docs или landing.
  7. Для нескольких языков соберите мультиязычный сайт и настройте общие подписи локали.
  8. При изменении URL объявите redirect.
  9. Сравните живые макеты и их точные исходники.
  10. При необходимости найдите компонент.
  11. Соберите и проверьте результат.

Не редактируйте output

build_*, квитанции в build_*.docara/ (resolved-page-plans.json, redirects.json и другие) и _docara/component-catalog.json создаются заново. Если результат неверен, исправьте исходный Markdown/JSON и повторите сборку.

Общая технология двух preset

docs и landing используют один content format, Framework lock и правила безопасности. Отличается только presentation recipe: документационный контекст или сфокусированная страница.

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

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

    Настройки

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