import { Callout, Steps } from 'nextra/components';

Quick Start

For general TypeDoc usage please refer to https://typedoc.org.

Installation

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

Plugins are loaded by using the TypeDoc plugin configuration option:

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

Or:

{
  "plugin": ["typedoc-plugin-markdown"],
  "out": "./docs"
}

{
  "docs": "typedoc"
}

npm run docs