typedoc-plugin-frontmatter
v1.3.2
Published
Adds configurable YAML frontmatter to TypeDoc Markdown output.
Readme
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.
Installation
npm install typedoc typedoc-plugin-markdown typedoc-plugin-frontmatter --save-devFeatures
- Apply global frontmatter variables to all pages.
- Configure specific pages with comment tags.
- Ability to customize the frontmatter using a local plugin.
Documentation
See the documentation for installation, configuration options, and usage guides.
License
MIT
