Начните со своей задачи
Хочу собрать первый сайт. Пройдите от пустого каталога до проверенной страницы в браузере.
Выбираю инструмент. Посмотрите, как устроены содержание, макеты, языки и навигация.
Буду развивать проект. Изучите архитектуру, компоненты, схемы и проверки.
Один источник — разные форматы
Всё важное для читателя
- Быстро найти материал. Дерево разделов, локальный поиск, хлебные крошки и содержание страницы сохраняют контекст.
- Читать на любом экране. Адаптивный макет, светлая и тёмная темы работают на общих токенах SIMAI Framework.
- Перейти на нужный язык. Каждый объявленный locale получает собственное дерево страниц и предсказуемые адреса.
- Не терять место в тексте. Содержание страницы отмечает текущий раздел, а переходы между материалами сохраняют маршрут чтения.
Всё важное для команды
Содержание остаётся содержанием
Markdown хранит текст, код и таблицы. JSON описывает сайт, разделы, страницы и области. Производный каталог сборки не нужно править вручную.
Компоненты работают как блоки
Типизированные компоненты расширяют Markdown, а сгенерированный каталог показывает точный вызов, возможности и состояние компонентов текущей сборки.
Макет задаётся отдельно
JSON хранит языки, области, макеты и наследование разделов отдельно от текста. Один источник можно представить как документацию или продуктовый лендинг.
Результат можно проверить
Зафиксированные revisions определяют версию SIMAI Framework. Статическая проверка находит повреждённые страницы и локальные ссылки до публикации.
От пустого каталога до готового сайта
- Создайте переносимый проект и объявите языки сайта.
- Напишите страницы в Markdown и настройте наследование через JSON.
- Соберите статический каталог одной PHP-командой.
- Проверьте результат в staging и публикуйте с подготовленным rollback.
php vendor/bin/docara init
php vendor/bin/docara build local
php vendor/bin/docara verify-static build_local
Из чего собирается страница
Markdown
Заголовки, абзацы, списки, таблицы, код и ссылки остаются читаемыми без специального редактора.
JSON
docara.json, section.json и необязательный JSON-файл страницы задают макет,
области, навигацию, поиск и локальные переопределения.
Компоненты
Docara-компоненты и допущенные Smart-компоненты SIMAI Framework добавляют уведомления, кнопки, первый экран, шаги, колонки, Promo и другие повторяемые блоки.
Статический результат
Сборка создаёт готовые HTML, CSS, JavaScript, ассеты и служебные отчёты. Серверу публикации не нужен PHP runtime Docara.
Система показывает, что именно она собрала
Квитанция build_production.docara/resolved-page-plans.json хранит эффективные настройки страницы и
происхождение значений. _docara/component-catalog.json фиксирует набор
компонентов, доступный в конкретной сборке.
Что важно знать
Документация описывает проверенный локальный контур. Она не заявляет готовность публичного релиза, поддержку каждого компонента SIMAI Framework, полностью автономную работу без сети или интеллектуальный поиск.
Частые вопросы
Нужен ли Node.js?
Авторскому проекту нужны PHP и Composer. Node.js требуется разработчикам исходных ассетов самой Docara, но не для обычной сборки сайта.
Можно ли сделать лендинг?
Да. Режим landing использует тот же Markdown, JSON и компоненты, но убирает
документационную навигацию и оставляет сфокусированную продуктовую страницу.
Можно ли добавить компонент?
Да. Начните с нативного Markdown, затем используйте типизированный Docara-компонент или допущенный Smart-компонент. Для расширений есть документированный контракт.
Как безопасно обновляться?
Фиксируйте revision, собирайте новый каталог отдельно, сравнивайте результат и публикуйте только после быстрой проверки с подготовленным rollback.