typedoc2md / typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://typedoc-plugin-markdown.org
MIT License
689 stars 172 forks source link
api documentation markdown typedoc typescript

typedoc-plugin-markdown

This project is a collection of packages designed for generate TypeScript API documentation as Markdown.

Documentation

Please see typedoc-plugin-markdown.org.

Packages

Package Version Downloads Changelog
typedoc-plugin-markdown npm Downloads Changelog
typedoc-plugin-frontmatter npm Downloads Changelog
typedoc-plugin-remark npm Downloads Changelog
typedoc-github-wiki-theme npm Downloads Changelog
typedoc-gitlab-wiki-theme npm Downloads Changelog
typedoc-vitepress-theme npm Downloads Changelog
docusaurus-plugin-typedoc npm Downloads Changelog

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.