typedoc-plugin-markdown

Overview

This repository provides a set of packages for generating TypeDoc output as Markdown and adapting that output for different publishing targets.

It includes the core Markdown plugin, utility plugins for frontmatter and remark transforms, themes for wiki and static-site workflows, and a Docusaurus integration that can run TypeDoc as part of the site toolchain.

If you want the simplest starting point, begin with typedoc-plugin-markdown.

Packages

Package	Description	Downloads	Changelog
typedoc-plugin-markdown	A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.		Changelog
typedoc-plugin-frontmatter	Adds configurable YAML frontmatter to Markdown generated by typedoc-plugin-markdown.		Changelog
typedoc-plugin-remark	Runs remark plugins against Markdown generated by typedoc-plugin-markdown.		Changelog
typedoc-github-wiki-theme	Formats Markdown generated by typedoc-plugin-markdown for GitHub Wiki.		Changelog
typedoc-gitlab-wiki-theme	Formats Markdown generated by typedoc-plugin-markdown for GitLab Wiki.		Changelog
typedoc-vitepress-theme	Formats Markdown generated by typedoc-plugin-markdown for VitePress.		Changelog
typedoc-docusaurus-theme	Formats Markdown generated by typedoc-plugin-markdown for Docusaurus.		Changelog
docusaurus-plugin-typedoc	Runs TypeDoc in the Docusaurus CLI and publishes Markdown generated by typedoc-plugin-markdown.		Changelog

Documentation

Please see typedoc-plugin-markdown.org.

Contributing

If you would like to contribute towards this project please read the contributing guide.

Examples

Please see the examples repository.

License

Released under the MIT License.