Skip to Content
DocsQuick Start

Quick Start

Installation

npm install typedoc typedoc-plugin-markdown --save-dev

Usage

Plugins are loaded by using the TypeDoc plugin configuration option:

CLI
typedoc --plugin typedoc-plugin-markdown --out ./docs

Or:

typedoc.json
{ "plugin": ["typedoc-plugin-markdown"], "out": "./docs" }
package.json
{ "docs": "typedoc" }
CLI
npm run docs
Last updated on