Workspace Docs

Appearance

Как doc_id попадает на сайт

Весь путь: от комментария в коде до страницы сайта ​

mermaid
flowchart TD
  S0["0. Проект задает
где искать docs и source"]
  S1["1. Autodoc находит
JSDoc-блоки с @doc_id"]
  S2["2. @doc_id связывает
блок со страницей"]
  S3["3. Page template выбирает
какие блоки вставить"]
  S4["4. Autodoc собирает
markdown-страницу"]
  S5["5. Markdown получает
кнопку src"]
  S6["6. Export сохраняет
manifest для сайта"]
  S0 --> S1 --> S2 --> S3 --> S4 --> S5 --> S6

0. Проект задает, где лежат страницы и исходники ​

Сначала Autodoc читает docs.config.ts: из него берутся pagesRoot, sourceRoot, exportDir, space и sidebar.

Подробнее: Doc Space Config.

1. Autodoc находит JSDoc-блоки с @doc_id ​

Подробнее: JSDoc Annotations.

2. @doc_id связывает блок с конкретной страницей ​

@doc_id задаёт адрес фрагмента. Exporter уже знает page id из page definition и ищет среди них самый длинный prefix, после которого в docId стоит точка.

Например, doc-links.syntax относится к странице doc-links, а syntax остаётся именем блока внутри этой страницы.

3. Page template выбирает, какие фрагменты попадут в страницу ​

Подробнее: Template API.

4. Autodoc собирает page.ts в markdown ​

Подробнее: Page Definitions.

5. Markdown получает кнопку src к исходному коду ​

Подробнее: Source Button.

6. Export сохраняет manifest для общего сайта ​

После компоновки autodoc сохраняет markdown-страницы и generated JSON в exportDir. manifest.json — это мост от export одного проекта к общей сборке сайта. Подробнее: Site Integration.

Mentioned In ​