Utils & Themes
Docusaurus

docusaurus-plugin-typedoc

Version: 1.0.5

Overview

This plugin integrates TypeDoc into the Docusaurus lifecycle and generates static TypeDoc pages in Markdown.

It is a Docusaurus plugin (not a TypeDoc plugin) and is designed to work within the Docusaurus lifecycle.

Features

  • Presets relevant options of typedoc-plugin-markdown.
  • Bootstraps TypeDoc from the Docusaurus CLI.
  • Generates a sidebar file with configurable structure.

Example

The following is a simple example of a Docusaurus project running TypeDoc.