Plugin options

Hierarchy

  • IPluginOptions

Properties

diagnostics?: string

The directory name where to output diagnostics data.

enablePageLinks: boolean

Whether or not {@page ...} tag should be parsed.

Default

true

enableSearch: boolean

Whether or not the pages should be added to the search index.

Default

true

excludeMarkdownTags?: string[]

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

invalidPageLinkHandling: EInvalidPageLinkHandling

The kind of error to throw in case of an invalid page link.

Default

LOG_ERROR

linkModuleBase: null | string

The container in packages to search for pages in "{@page ...}" tags.

logLevel: LogLevel

The plugin log level.

Default

application.logger.level

output: string

Output directory where your pages will be rendered.

Default

'pages'

The pages definition.

See

Managing pages & menu items for details.

Generated using TypeDoc