Skip to content

Autodoc System

Overview

Autodoc — система автодокументации, где source of truth живет в коде. Вы пишете JSDoc-комментарии с @doc_id, autodoc собирает их в страницы и генерирует сайт. Документация не устаревает, потому что она — часть исходников.

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

@doc_id проходит pipeline от JSDoc-блока до rendered markdown: autodoc извлекает фрагмент, связывает его со страницей, вставляет через includeDoc() и пишет generated artifacts для сайта.

Подробнее: Как doc_id попадает на сайт.

Mentioned In