typedoc-plugin-method-summary

A TypeDoc plugin that adds compact method summary tables to typedoc-plugin-markdown output.

Note: This plugin was engineered by an autonomous agent — Claude Code (Claude Opus 4.6).

Problem

typedoc-plugin-markdown renders properties as a compact table but methods as individual verbose sections. For large interfaces (40+ methods), there's no quick-nav overview — you have to scroll through hundreds of lines to find what you need.

Solution

This plugin injects a summary table at the top of each Methods section:

Method	Description
select(moduleName, name)	Select an item by module name and name.
deselect()	Clear selection.
dispose()	Dispose the editor API and clean up listeners.

Each method name links to its detailed documentation below.

Install

npm install typedoc-plugin-method-summary

Usage

Add the plugin and theme to your typedoc.json:

{
  "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-method-summary"],
  "theme": "markdown-with-summary"
}

That's it. Run typedoc as usual.

Options

Option	Type	Default	Description
methodSummaryEnabled	boolean	true	Toggle summary tables on/off
methodSummaryMaxDescription	number	120	Max characters for the description column

Peer Dependencies

• typedoc >= 0.27
• typedoc-plugin-markdown >= 4.0

License

MIT