A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
See the codeGenerate TypeScript API documentation as Markdown with TypeDoc.
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.
| Package | Description | Downloads | Changelog |
|---|---|---|---|
| typedoc-plugin-markdown | A TypeDoc plugin that 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 |
See typedoc-plugin-markdown.org for installation, options, guides, and package documentation.
If you would like to contribute towards this project please read the contributing guide.
Released under the MIT License.
(top 24 of 35)
10,167 followers · starred Jul 2023
4,359 followers · starred Mar 2025
75 followers · starred Nov 2021
625 followers · starred Aug 2024
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
See the codeGenerate TypeScript API documentation as Markdown with TypeDoc.
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.
| Package | Description | Downloads | Changelog |
|---|---|---|---|
| typedoc-plugin-markdown | A TypeDoc plugin that 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 |
See typedoc-plugin-markdown.org for installation, options, guides, and package documentation.
If you would like to contribute towards this project please read the contributing guide.
Released under the MIT License.
(top 24 of 35)
10,167 followers · starred Jul 2023
4,359 followers · starred Mar 2025
75 followers · starred Nov 2021
625 followers · starred Aug 2024
