typedoc-plugin-banish

1.0.1 • Public • Published

typedoc-plugin-banish

A plugin for TypeDoc which filters reflections according to their declaration location, like --exclude but better since it also catches inherited items.

This plugin adds two options:

Option Default Description
banish ["**/node_modules/**"] Array of minimatch patterns to match declaration locations against. If any match, the item will not be included in the documentation.
invertBanish false If set, only include declarations whose locations are matched by banish

TypeDoc automatically loads plugins, so all you need to do to use this plugin is install it. If you selectively load plugins, add it to your plugins array in typedoc.json

{
  "banish": ["**/node_modules/**", "**/src/internal.ts"],
  "invertBanish": false,
  "plugins": ["typedoc-plugin-banish"]
}

Readme

Keywords

Package Sidebar

Install

npm i typedoc-plugin-banish

Weekly Downloads

2

Version

1.0.1

License

MIT

Unpacked Size

5.47 kB

Total Files

6

Last publish

Collaborators

  • gerrit0