Configures how Obsidian (the app) will render its markdown.

interface ObsidianMarkdownProps {
    app: App;
    component: Component;
    delay?: DurationLike;
    markdown: string;
    sourcePath: string;
    tagName?: keyof IntrinsicElements;
}

Properties

app: App

A reference to the Obsidian app object.

component: Component

A parent component to manage the lifecycle of the rendered child components.

delay?: DurationLike

Custom debounce time for renders.

markdown: string

The Markdown source code.

sourcePath: string

The normalized path of this Markdown file, used to resolve relative internal links.

tagName?: keyof IntrinsicElements

The tag used to contain the rendered Markdown source code.