docusaurus-plugin-typedoc

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.

Alternatives

A popular alternative to this plugin is docusaurus-plugin-typedoc-api.

The main difference is:

• docusaurus-plugin-typedoc-api renders dynamic React pages offering a rich and flexible UI and is fully integrated with the Docusaurus ecosystem.
• docusaurus-plugin-typedoc (this plugin) renders static markdown files but is more integrated with the TypeDoc ecosystem and is compatible with other TypeDoc plugins.

In the end it comes down to personal preference and the requirements of your project.

Example

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