Quick Start

Installation

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

pnpm add typedoc typedoc-plugin-markdown --save-dev

yarn add typedoc typedoc-plugin-markdown --dev

bun add typedoc typedoc-plugin-markdown --dev

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