Skip to content

MarkdownWriteOptions

Defined in: src/markdown/markdown-writer.ts:53

Options for writeMarkdown.

readonly optional images?: "dataUri" | "link" | "drop"

Defined in: src/markdown/markdown-writer.ts:61

How a picture reaches the output. 'dataUri' (the default) inlines the bytes as a data: URI, keeping the single-blob WriteResult contract and the zero-I/O promise; 'link' emits a relative ./media/… path and records that the bytes were not written anywhere; 'drop' omits pictures entirely.


readonly optional pageBreaks?: "drop" | "rule"

Defined in: src/markdown/markdown-writer.ts:70

What a page break becomes. 'drop' (the default) leaves it out and reports it: a paginated document breaks its pages wherever the layout needs to, and a rule at every one of them would litter the text. 'rule' writes a --- thematic break instead, which is what a SLIDE DECK wants — the .pptx and .ppt readers mark each slide boundary with a page break, and it is the only structure a deck has.