Skip to Content
DocsQuick Start

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

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
{ "plugin": ["typedoc-plugin-markdown"], "out": "./docs" }

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
Last updated on