typedoc-plugin-markdown
v4.12.0
Published
Generates TypeScript API documentation as Markdown.
Maintainers
Readme
typedoc-plugin-markdown
Overview
TypeDoc generates API documentation for TypeScript projects as HTML by default. This plugin adds Markdown output that can be easily integrated into different ecosystems, such as code repositories, wikis, and static site generators.
Installation
npm install typedoc typedoc-plugin-markdown --save-devFeatures
- Generates CommonMark, GFM, and MDX-compatible Markdown from TypeDoc projects.
- Works alongside other TypeDoc plugins.
- Configurable output structure.
- Companion plugins for frontmatter and remark transforms.
- Companion themes for Docusaurus, VitePress, GitHub Wiki, and GitLab Wiki workflows.
Documentation
See the documentation for installation, configuration options, and usage guides.
Examples
See the examples repository for generated output and publishing examples.
License
MIT
