Local plugins

Plugins are the building blocks for extending the TypeDoc output. Plugins export a load function with context of the resolved application.

Here is a basic plugin skeleton:

// @ts-check
 
import { MarkdownApplication } from 'typedoc-plugin-markdown';
 
/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
export function load(app) {
  // do something with app instance
}

The plugin can then be consumed by adding the path to the plugin in your typedoc.json file:

{
  "plugin": ["typedoc-plugin-markdown", "./local-plugins/my-custom-plugin.mjs"]
}

Note plugins must be consumed as ESM.

See

• Writing a TypeDoc plugin