Function: renderMarkdown()

function renderMarkdown(md, opts?): Promise<Result<string, Diagnostic[]>>;

Defined in: integrations/markdown.ts:53

Replace every ```typeDiagram fenced block with the rendered SVG inline. Other fences pass through untouched. If a fence fails to render, its diagnostics are surfaced in the Result; the markdown is still returned with the failed fence replaced by an HTML comment containing the formatted diagnostics.

Parameters

md

string

opts?

AllOpts = {}

Returns

Promise<Result<string, Diagnostic[]>>