Workspace Docs

Appearance

Doc Space Config

Что это ​

Doc space config — это файл docs.config.ts, с которого Autodoc начинает сборку. Он отвечает на простые вопросы:

  • как называется пространство документации;
  • где лежат page-файлы;
  • где искать JSDoc-фрагменты с @doc_id;
  • куда писать сгенерированные markdown и manifest;
  • какое дерево навигации использовать.

Обычно этот файл нужен один раз на проект.

Пример ​

ts
import { defineDocSpace } from "./src/index.ts";
import sidebar from "./docs/sidebar";

export default defineDocSpace({
  space: "autodoc",
  title: "Autodoc",
  pagesRoot: "docs/pages",
  sourceRoot: "src",
  exportDir: ".autodoc/export/autodoc",
  sidebar,
});

Основные поля ​

  • space — короткий id пространства. Используется в ссылках вида builder:storage.
  • title — название пространства в навигации сайта.
  • pagesRoot — папка с файлами page.ts.
  • sourceRoot — папка, которую Autodoc сканирует на JSDoc-фрагменты.
  • exportDir — папка для результата экспорта.
  • sidebar — дерево страниц для меню.

defineDocSpace() ​

defineDocSpace() оставляет docs.config.ts типизированным, а source of truth держит в страницах, JSDoc-фрагментах и sidebar config.

Mentioned In ​