Заготовки и окружение

Команда init из быстрого старта создаёт проект из заготовки. Здесь описано, какую заготовку выбрать, что появится в каталоге и что должно быть в окружении сборки.

Выбор заготовки

init принимает два параметра: --template (-t) выбирает заготовку, а --lang (-l) — язык её содержимого. По умолчанию используется --template=minimal --lang=en: небольшой рабочий сайт на английском. Заготовку выбирают при первом init (шаг 1 быстрого старта): в уже созданном проекте init откажется работать.

# Небольшой сайт на русском
php vendor/bin/docara init . --lang=ru

# Каталог компонентов, лендинг, вложенные руководства и Smart-примеры
php vendor/bin/docara init . --template=showcase --lang=ru

Заготовка showcase написана только на русском. Сочетание --template=showcase --lang=en завершается понятной ошибкой и ничего не записывает.

Окружение сборки

Docara содержит закреплённую поставку SIMAI Framework вместе со средой выполнения Composition Recipe. Отдельная копия Framework и переменные окружения для неё не нужны.

Node.js должен быть доступен командой node. Если он установлен в другом месте, задайте export DOCARA_NODE_BINARY=/path/to/node в окружении сборки, включая автоматические проверки и обновление Docara.

Проверить установку без сборки можно двумя командами: capabilities сообщает версию и возможности установленной Docara, doctor — состояние контрактов проекта.

php vendor/bin/docara capabilities --json
php vendor/bin/docara doctor --json

Обновление

Docara обновляется одной командой php vendor/bin/docara upgrade, а возвращается к прежней проверенной версии командой php vendor/bin/docara upgrade --rollback=latest. Как это работает и что проверяется, описано в разделе «Обновление Docara».

Какие файлы создаёт заготовка

Заготовка minimal с --lang=ru создаёт такие файлы:

docara.json
docara.authoring.json
AGENTS.md
composer.json
composer.lock
vendor/
redirects.json
simai-framework.lock.json
assets/
contracts/
.docara/
  engine/
content/
  ru/
    section.json
    lang.json
    index.md
    index.page.json
    writing.md
    writing.page.json
    components.md
    components.page.json
    getting-started/
    how-to/
    reference/
    explanation/

С --lang=en содержимое лежит в content/en/. Сайт одноязычный, маршруты без языкового префикса: /, /writing/, /components/.

Четыре каталога — каркас документации по типам страниц: урок, инструкция, справочник и объяснение. В каждом лежит короткий пример страницы своего типа: замените его своим текстом. docara.authoring.json включает проверку типов страниц, а AGENTS.md пересказывает тот же стандарт для ИИ-помощников. Как это работает, описано в Профилях страниц.

См. также

• Файлы проекта — назначение каждого файла и каталога
• Команды CLI — все параметры init, capabilities и doctor