MarkdownPageEvent
An event emitted before and after the markdown of a page is rendered.
Extends
Event
Events
BEGIN
readonly
static
BEGIN:"beginPage"
='beginPage'
Triggered before a document will be rendered.
END
readonly
static
END:"endPage"
='endPage'
Triggered after a document has been rendered, just before it is written to disc.
Properties
project
project:
ProjectReflection
The ProjectReflection
instance the renderer is currently processing.
model
readonly
model:Model
The model that that is being rendered on this page.
Either a DeclarationReflection
or ProjectReflection
.
url
url:
string
The url string
of the page.
filename
filename:
string
The complete string
filename where the file will be written..
group?
optional
group:string
The group title of the group reflection belongs to.
contents?
optional
contents:string
The final markdown string
content of the page.
Should be rendered by layout templates and can be modified by plugins.
frontmatter?
optional
frontmatter:Record
<string
,any
>
The frontmatter of this page represented as a key value object. This property can be utilised by other plugins.