Workspace Docs

Appearance

CLI

CLI: обзор. autodoc — командная строка для работы с doc-space.

Две команды:

  • export --config <path> — извлекает @doc_id фрагменты, компонует страницы, генерирует markdown, сниппеты и manifest.json в exportDir. Это основная команда, которую вызывает site/scripts/prepare.ts для каждого пространства.
  • dev --config <path> — поднимает VitePress dev-сервер для локальной разработки одного space: export → materialize → vitepress dev + watcher.

Опции:

  • --config <path> — путь к doc-space config (по умолчанию docs.config.ts).
  • --site-dir <path> — куда материализовать локальный VitePress-сайт.
  • --host / --port — адрес и порт VitePress dev сервера.

Скрипты одного проекта ​

Эти scripts живут в package.json конкретного doc-space. Они работают с одним docs.config.ts и одним exportDir. Для проекта, который подключается к общему сайту, docs:export — обязательный контракт: site build вызывает именно его.

json
{
  "scripts": {
    "docs:export": "autodoc export --config docs.config.ts"
  }
}

autodoc export справа — реальная CLI-команда. docs:export слева — имя npm/yarn script, на которое опирается общий сайт.

Остальные docs:* scripts — локальные команды для удобства:

json
{
  "scripts": {
    "docs:lint": "autodoc lint --config docs.config.ts",
    "docs:dev": "autodoc dev --config docs.config.ts --port 5176",
    "docs:build": "autodoc build --config docs.config.ts",
    "docs:preview": "autodoc preview --config docs.config.ts --port 4176"
  }
}

Скрипты общего сайта ​

Эти scripts запускаются из workspace-docs и собирают единый VitePress сайт из нескольких doc-space.

json
{
  "scripts": {
    "site:prepare": "yarn workspace @workspace-docs/site site:prepare",
    "site:dev": "yarn workspace @workspace-docs/site site:dev",
    "site:build": "yarn workspace @workspace-docs/site site:build",
    "site:preview": "yarn workspace @workspace-docs/site site:preview"
  }
}
  • site:prepare запускает site/scripts/prepare.ts: подготавливает все spaces, вызывает в каждом yarn docs:export, копирует markdown/snippets и пишет общий catalog.json.
  • site:dev делает prepare и запускает VitePress dev-сервер общего сайта.
  • site:build делает prepare и собирает общий статический сайт.
  • site:preview показывает уже собранный общий сайт.

Подробнее про объединение нескольких проектов: Site Integration.

Mentioned In ​