typedoc-plugin-md
v0.3.1
Published
A typedoc plugin for generating markdown documentation
Downloads
381
Maintainers
Readme
typedoc-plugin-md
A TypeDoc plugin for generating Markdown documentation from your TypeScript code.
Installation
npm install -D typedoc typedoc-plugin-md
Usage
typedoc --plugin typedoc-plugin-md --out ./docs ./src/index.ts
Related projects
- typedoc-plugin-markdown -
typedoc-plugin-md
is highly inspired bytypedoc-plugin-markdown
.typedoc-plugin-md
has an opinionated output format. If you need more customization options, you might prefertypedoc-plugin-markdown
.
License
MIT