Quick Start

Below is a minimal setup for this plugin. For full configuration details, see the TypeDoc documentation .

Install


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

Configure

Plugins are enabled using TypeDoc’s --plugin configuration option. You can provide options directly in the CLI command or using a TypeDoc configuration file as below.

typedoc.json


{
  "$schema": "node_modules/typedoc-plugin-markdown/typedoc-plugin-markdown.schema.json",
  "plugin": ["typedoc-plugin-markdown"],
  "out": "./docs"
}

The $schema entry is optional, but lets your editor validate and autocomplete both TypeDoc’s and this plugin’s options. See Schema for the hosted alternative and for typing a JavaScript config.

Add a docs script to your package.json file:

package.json


{
  "scripts": {
    "docs": "typedoc"
  }
}

Build

You are now ready to build your documentation.

CLI


npm run docs