Class MarkdownEvent

An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.

See

MarkdownEvent.PARSE

Index

Constructors

constructor

new MarkdownEvent(
    page: PageEvent,
    originalText: string,
    parsedText: string,
): MarkdownEvent
Parameters
- page: PageEvent
- originalText: string
- parsedText: string
Returns MarkdownEvent
- Defined in lib/output/events.ts:194

Events

`Static` `Readonly`PARSE

PARSE: "parseMarkdown"

Triggered on the renderer when this plugin parses a markdown string.

Properties

`Readonly`originalText

originalText: string

The unparsed original text.

`Readonly`page

page: PageEvent

The page that this markdown is being parsed for.

parsedText

parsedText: string

The parsed output.

Class MarkdownEvent

See

Index

Constructors

Events

Properties

Constructors

constructor

Parameters

Returns MarkdownEvent

Events

`Static` `Readonly`PARSE

Properties

`Readonly`originalText

`Readonly`page

parsedText

Settings

On This Page

Class MarkdownEvent

See

Index

Constructors

Events

Properties

Constructors

constructor

Parameters

Returns MarkdownEvent

Events

Static ReadonlyPARSE

Properties

ReadonlyoriginalText

Readonlypage

parsedText

Settings

On This Page

`Static` `Readonly`PARSE

`Readonly`originalText

`Readonly`page