MarkdownRenderer.renderMarkdown method

MarkdownRenderer › renderMarkdown

Official

Renders Markdown string to an HTML element.

Signature:

renderMarkdown(markdown: string, el: HTMLElement, sourcePath: string, component: Component): Promise<void>

Parameters:

Parameter	Type	Description
markdown	string	The Markdown source code.
el	HTMLElement	The element to append to.
sourcePath	string	The normalized path of this Markdown file, used to resolve relative internal links.
component	Component	A parent component to manage the lifecycle of the rendered child components.

Returns: Promise<void>

Since: 0.10.6