TypeDoc Plugins

TypeDoc provides a wide array of plugins contributed by the community. These plugins expand the capabilities of TypeDoc, enabling you to customize and adapt your documentation to meet your specific needs. Here are some of the noteworthy plugins:

For example purposes this is the ./src structure

src/
|---interfaces/
    |---ITest.ts
|---implementation/
    |---Test.ts
|---helpers.ts

1. typedoc-plugin-merge-modules By default, TypeDoc organizes everything within modules, and this plugin helps resolve this issue. However, it's crucial to be aware that for more larger projects, using this plugin may lead to an increased volume of information on the landing page as it combines modules.

1. typedoc-theme-hierarchy This plugin transforms the appearance of your documentation's sidebar to mimic your project's folder structure. It offers users an intuitive way of navigating through the documentation by replicating the project's file structure.

1. typedoc-plugin-markdown This plugin changes how TypeDoc default behavior by transforming the standard HTML output into Markdown format.

Tip: Combine plugins for enhanced documentation.