Skip to content

MarkdownRenderer.render method

MarkdownRenderer › render

Official

Renders Markdown string to an HTML element.

Signature:

render(app: App, markdown: string, el: HTMLElement, sourcePath: string, component: Component): Promise<void>

Parameters:

Parameter Type Description
app App A reference to the app object
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>