Skip to content

Template API

md — Tagged Template

md собирает template strings страницы и docs-узлы в плоский массив содержимого страницы. Шаблоны остаются похожими на обычный markdown, но сохраняют структурные узлы вроде includeDoc() и section().

includeDoc()

includeDoc() ставит в page template ссылку на JSDoc-фрагмент по его @doc_id. Page template не копирует текст фрагмента руками: он хранит только target id, а сам текст остаётся в JSDoc-блоке до этапа рендера.

section()

section() добавляет в template страницы структурный раздел: заголовок и дочернее содержимое. Как именно этот узел превращается в markdown, решает exporter на этапе рендера страницы.

Сейчас section() рендерится как markdown h2: exporter не хранит уровень секции в template-node и всегда выводит ##.

TODO

Рассмотреть генерацию вложенных секций, чтобы section() мог создавать не только h2, но и дочерние уровни вроде h3/h4.

Mentioned In