MarkdownRendererEvent

An event emitted at the beginning and end of the rendering process.

Extends

• Event

Events

BEGIN

readonly static BEGIN: "beginRender" = 'beginRender'

Triggered before the renderer starts rendering a project.

END

readonly static END: "endRender" = 'endRender'

Triggered after the renderer has written all documents.

Properties

project

readonly project: ProjectReflection

The project the renderer is currently processing.

outputDirectory

readonly outputDirectory: string

The path of the directory the documentation should be written to.

urls?

optional urls: UrlMapping<Reflection>[]

A list of all pages that should be generated.

navigation?

optional navigation: NavigationItem[]

The navigation structure of the project that can be utilised by plugins.