UNPKG

typedoc-plugin-markdown

Version:

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

typedoc-plugin-markdown.org

typedoc2md/typedoc-plugin-markdown

19 lines (11 loc) • 749 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# typedoc-plugin-markdown [![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.yml) > A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown. ## Installation ```shell npm install typedoc typedoc-plugin-markdown --save-dev ``` ## Documentation Please visit [https://typedoc-plugin-markdown.org](https://typedoc-plugin-markdown.org) for comprehensive documentation, including options and usage guides. ## License MIT