Class MermaidMarkdown

An implementation of mermaid fenced code blocks in markdown.

Implements

IMermaidMarkdown

Index

Constructors

Properties

_mermaid languages rank

Methods

Constructors

constructor

new MermaidMarkdown(options: MermaidMarkdown.IOptions): MermaidMarkdown
Parameters
- options: MermaidMarkdown.IOptions
Returns MermaidMarkdown
- Defined in packages/mermaid/src/markdown.ts:14

Properties

`Protected`_mermaid

_mermaid: IMermaidManager

`Readonly`languages

languages: string[] = ...

The languages this block accepts.

`Readonly`rank

rank: 100

The order in which the block would be processed

Methods

render

render(text: string): null | string
Render the diagram.
Parameters
- text: string
Returns null | string
Implementation of IMermaidMarkdown.render
- Defined in packages/mermaid/src/markdown.ts:28

walk

walk(text: string): Promise<void>
Pre-parse and cache the rendered text.
Parameters
- text: string
Returns Promise<void>
Implementation of IMermaidMarkdown.walk
- Defined in packages/mermaid/src/markdown.ts:21