docusaurus-plugin-typedoc
v1.4.3
Published
Runs TypeDoc inside the Docusaurus lifecycle.
Readme
docusaurus-plugin-typedoc
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.
Internally, it uses typedoc-docusaurus-theme to generate Docusaurus-compatible Markdown and sidebar data.
Installation
npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-devFeatures
- Bootstraps TypeDoc from the Docusaurus CLI.
- Uses
typedoc-docusaurus-themeinternally for Docusaurus-compatible output. - Supports generating API docs as part of the standard Docusaurus workflow.
Documentation
See the documentation for installation, configuration options, and usage guides.
License
MIT
