Quick Start

Installation


npm install typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --save-dev


pnpm add typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --save-dev


yarn add typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --dev


bun add typedoc typedoc-plugin-markdown typedoc-github-wiki-theme --dev

typedoc.json


{
  "plugin": ["typedoc-plugin-markdown", "typedoc-github-wiki-theme"]
}

CLI


npm run typedoc

Last updated on September 19, 2025