typedoc-plugin-markdown
Generate TypeScript API documentation as Markdown with TypeDoc.
Overview
This repository contains the core Markdown plugin, utility plugins for frontmatter and remark transforms, target-specific themes for wiki and static-site workflows, and a Docusaurus plugin that can run TypeDoc inside the Docusaurus lifecycle.
Start with typedoc-plugin-markdown for the core Markdown output, then add the package that matches where you publish your docs.
Packages
| Package | Description | Downloads | Changelog |
|---|---|---|---|
| typedoc-plugin-markdown | Generates TypeScript API documentation as Markdown. |  |
Changelog |
| typedoc-plugin-frontmatter | Adds configurable YAML frontmatter to TypeDoc Markdown output. |  |
Changelog |
| typedoc-plugin-remark | Runs remark plugins on TypeDoc Markdown output. |  |
Changelog |
| typedoc-github-wiki-theme | Generates TypeDoc Markdown output for GitHub Wiki. |  |
Changelog |
| typedoc-gitlab-wiki-theme | Generates TypeDoc Markdown output for GitLab Wiki. |  |
Changelog |
| typedoc-vitepress-theme | Generates TypeDoc Markdown output for VitePress. |  |
Changelog |
| typedoc-docusaurus-theme | Generates TypeDoc Markdown output for Docusaurus. |  |
Changelog |
| docusaurus-plugin-typedoc | Runs TypeDoc inside the Docusaurus lifecycle. |  |
Changelog |
Documentation
See typedoc-plugin-markdown.org for installation, options, guides, and package documentation.
Contributing
If you would like to contribute towards this project please read the contributing guide.
License
Released under the MIT License.