Interface IPluginOptions

Plugin options

Hierarchy

  • IPluginOptions

Properties

enablePageLinks enableSearch excludeMarkdownTags? invalidPageLinkHandling logLevel output pages source

Properties

enablePageLinks

enablePageLinks: boolean

Whether or not

Page

and

Pagelink

tags should be parsed.

Default

true

enableSearch

enableSearch: boolean

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

Default

true

Optional excludeMarkdownTags

excludeMarkdownTags?: string[]

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

invalidPageLinkHandling

invalidPageLinkHandling: EInvalidPageLinkHandling

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

Default

LOG_ERROR

logLevel

logLevel: LogLevel

The plugin log level.

Default

application.logger.level

output

output: string

Output directory where your pages will be rendered.

Default

'pages'

pages

pages: IRootPageNode[]

The pages definition.

See

Pages tree for details.

source

source: string

Root directory where all page source files live.

Default

'pages'

Settings

Member Visibility

Theme

Generated using TypeDoc