Interface IPluginOptions

Plugin options

Hierarchy

  • IPluginOptions

Properties

defaultBlockMode excludeMarkdownTags? invalidBlockLinkHandling logLevel source

Properties

defaultBlockMode

defaultBlockMode: EBlockMode

The default mode for blocks.

Default

EBlockMode.EXPANDED

Optional excludeMarkdownTags

excludeMarkdownTags?: string[]

A list of markdown captures to omit. Should have the form {@....}.

invalidBlockLinkHandling

invalidBlockLinkHandling: EInvalidBlockLinkHandling

The kind of error to throw in case of an invalid code block reference.

Default

EInvalidBlockLinkHandling.LOG_ERROR

logLevel

logLevel: LogLevel

The plugin log level.

Default

application.logger.level

source

source: string

Root directory where all code blocks live.

Default

'examples'

Settings

Member Visibility

Theme

Generated using TypeDoc