typedoc-plugin-frontmatter

Overview

typedoc-plugin-frontmatter adds YAML frontmatter to the Markdown files generated by typedoc-plugin-markdown.

Use it when your target docs system reads page metadata from frontmatter and you want titles, slugs, sidebar labels, or custom page data generated alongside the API docs.

Features

• Apply global frontmatter variables to all pages.
• Configure specific pages with comment tags.
• Ability to customize the frontmatter using a local plugin.

Examples