Skip to content

Latest commit

 

History

History

README.md

docusaurus-plugin-typedoc

npm Downloads Build Status

Overview

docusaurus-plugin-typedoc runs TypeDoc as part of the Docusaurus toolchain, so API docs can be generated during the normal Docusaurus dev and build flow.

Use it when you want Docusaurus to own the TypeDoc execution step instead of maintaining a separate docs generation command.

Installation

npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev

Features

  • Bootstraps TypeDoc from the Docusaurus CLI.
  • Uses the Docusaurus integration defaults from typedoc-plugin-markdown.
  • Supports generating API docs as part of the standard Docusaurus workflow.

Documentation

See the documentation for installation, configuration options, and usage guides.

License

MIT