https://github.com/typedoc2md/typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
https://github.com/typedoc2md/typedoc-plugin-markdown

api documentation markdown typedoc typescript

Last synced: 5 days ago
JSON representation

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

• Host: GitHub
• URL: https://github.com/typedoc2md/typedoc-plugin-markdown
• Owner: typedoc2md
• License: mit
• Created: 2017-05-25T22:47:52.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2025-04-23T11:13:46.000Z (10 days ago)
• Last Synced: 2025-04-24T10:09:57.452Z (9 days ago)
• Topics: api, documentation, markdown, typedoc, typescript
• Language: TypeScript
• Homepage: https://typedoc-plugin-markdown.org
• Size: 15.9 MB
• Stars: 767
• Watchers: 9
• Forks: 183
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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](https://typedoc-plugin-markdown.org).

## Packages

| Package | Version | Downloads | Changelog 

| :---| :---| :---| :---|

[typedoc-plugin-markdown](./packages/typedoc-plugin-markdown#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) | ![Downloads](https://img.shields.io/npm/dw/typedoc-plugin-markdown?label=↓) | [Changelog](./packages/typedoc-plugin-markdown/CHANGELOG.md) | 

[typedoc-plugin-frontmatter](./packages/typedoc-plugin-frontmatter#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-frontmatter.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-frontmatter) | ![Downloads](https://img.shields.io/npm/dw/typedoc-plugin-frontmatter?label=↓) | [Changelog](./packages/typedoc-plugin-frontmatter/CHANGELOG.md) | 

[typedoc-plugin-remark](./packages/typedoc-plugin-remark#readme) | [![npm](https://img.shields.io/npm/v/typedoc-plugin-remark.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-remark) | ![Downloads](https://img.shields.io/npm/dw/typedoc-plugin-remark?label=↓) | [Changelog](./packages/typedoc-plugin-remark/CHANGELOG.md) | 

[typedoc-github-wiki-theme](./packages/typedoc-github-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-github-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-github-wiki-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-github-wiki-theme?label=↓) | [Changelog](./packages/typedoc-github-wiki-theme/CHANGELOG.md) | 

[typedoc-gitlab-wiki-theme](./packages/typedoc-gitlab-wiki-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-gitlab-wiki-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-gitlab-wiki-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-gitlab-wiki-theme?label=↓) | [Changelog](./packages/typedoc-gitlab-wiki-theme/CHANGELOG.md) | 

[typedoc-vitepress-theme](./packages/typedoc-vitepress-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-vitepress-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-vitepress-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-vitepress-theme?label=↓) | [Changelog](./packages/typedoc-vitepress-theme/CHANGELOG.md) | 

[typedoc-docusaurus-theme](./packages/typedoc-docusaurus-theme#readme) | [![npm](https://img.shields.io/npm/v/typedoc-docusaurus-theme.svg?logo=npm)](https://www.npmjs.com/package/typedoc-docusaurus-theme) | ![Downloads](https://img.shields.io/npm/dw/typedoc-docusaurus-theme?label=↓) | [Changelog](./packages/typedoc-docusaurus-theme/CHANGELOG.md) | 

[docusaurus-plugin-typedoc](./packages/docusaurus-plugin-typedoc#readme) | [![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc.svg?logo=npm)](https://www.npmjs.com/package/docusaurus-plugin-typedoc) | ![Downloads](https://img.shields.io/npm/dw/docusaurus-plugin-typedoc?label=↓) | [Changelog](./packages/docusaurus-plugin-typedoc/CHANGELOG.md) | 

## Contributing

If you would like to contribute towards this project please read the [contributing guide](./CONTRIBUTING.md).

## Examples

Please see the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples).

## License

Released under the [MIT License](./LICENSE).