Skip to content

TypeDoc

Enabled

This plugin is enabled when there’s a match in dependencies or devDependencies in package.json:

  • typedoc

Default configuration

This configuration is added automatically if the plugin is enabled:

{
"typedoc": {
"config": [
"typedoc.{js,cjs,mjs,json,jsonc}",
"typedoc.config.{js,cjs,mjs}",
".config/typedoc.{js,cjs,mjs,json,jsonc}",
".config/typedoc.config.{js,cjs,mjs}",
"package.json",
"tsconfig.json"
]
}
}

Your custom config or entry options override default values, they are not merged.

See Plugins for more details about plugins and their entry and config options.

Shell commands

This plugin adds argument parsing for the typedoc binary. Configuration:

resolve: ["plugin","theme"]

Generated from source

This page was generated from the typedoc plugin source code.

ISC License © 2024 Lars Kappert