writeMarkdown
writeMarkdown(
flow,options?):WriteResult
Defined in: src/markdown/markdown-writer.ts:86
Render a FlowDoc to GitHub-Flavored Markdown (ir-design §7).
A flow medium: no pagination, no layout engine and no fonts, so this is a pure, zero-I/O transform. Markdown says far less than the document model does — alignment, indents, colour, font metrics, tab stops and page geometry have no expression at all — so those are dropped and reported as Loss entries, deduplicated so one recurring omission reports once.
Parameters
Section titled “Parameters”The format-neutral interlayer document tree.
options?
Section titled “options?”MarkdownWriteOptions = {}
Picture handling; see MarkdownWriteOptions.
Returns
Section titled “Returns”The encoded Markdown bytes plus the recorded Loss list.