typedoc-plugin-markdown

Version: 4.11.0

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.

Features

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.

Examples

See the examples repository for generated output and publishing examples.