Содержание и макет
В переносимом Docara файлы являются источником истины:
- Markdown хранит текст и структуру содержания;
docara.jsonзадаёт сайт;redirects.jsonсохраняет обязательные старые внутренние URL;section.jsonзадаёт наследуемые значения ветки;- необязательный
<page>.page.jsonуточняет только одну страницу; - generator создаёт HTML, indexes и диагностические artifacts.
Простое правило
Начинайте с обычного Markdown. Добавляйте JSON только для представления и навигации. Выбирайте компонент только тогда, когда Markdown недостаточно, и берите точный вызов из справочника компонентов.
Путь автора
- Разберитесь с файлами проекта.
- Напишите страницу в Markdown.
- Настройте сайт, раздел или страницу.
- Добавьте название, логотип и favicon.
- Проверьте наследование и
$reset. - Выберите
docsилиlanding. - Для нескольких языков соберите мультиязычный сайт и настройте общие подписи локали.
- При изменении URL объявите redirect.
- Сравните живые макеты и их точные исходники.
- При необходимости найдите компонент.
- Соберите и проверьте результат.
Не редактируйте 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: документационный контекст
или сфокусированная страница.