Using options

Providing options

See Providing options to know more about how you can pass options.

Options are prefixed with pluginCodeBlocks.

You can also use the TypeDoc CLI to get all available options.

typedoc --help

Complete list of options

• invalidBlockLinkHandling: The kind of error to throw in case of an invalid code block reference.
  Type: EInvalidBlockLinkHandling
  Default: EInvalidBlockLinkHandling.LOG_ERROR
• defaultBlockMode: The default mode for blocks.
  Type: EBlockMode
  Default: EBlockMode.EXPANDED
• source: Root directory where all code blocks live.
  Type: string
  Default: 'examples'
• logLevel: The plugin log level.
  Type: LogLevel
  Default to the application log level.
• excludeMarkdownTags: A list of markdown captures to omit. Should have the form {@....}.
  Type: string[]

See IPluginOptions