Skip to main content

to_markdown_with_options

Function to_markdown_with_options 

Source
pub fn to_markdown_with_options(
    blocks: &[Block],
    options: &MarkdownOptions,
) -> String
Expand description

The block model and both serialisations of it, re-exported from pdf-engine: what PdfDocument::extract_blocks hands back, which pages it hands back, and the two ways to write them out (#573).

One definition and not a facade copy of it, for the reason ProcessingLimits is re-exported rather than mirrored: a caller holding a Block from the facade and one from the engine must be holding the same type, or every consumer of both has to convert between two shapes that carry identical fields. to_markdown, with the furniture and the page marker as options says.

Preview: output quality is still improving and the API may change in a minor release.

With MarkdownOptions::include_headers the running heads, and with MarkdownOptions::include_footers the page numbers, are written as plain paragraphs at their reading-order position; with PageSeparators::None a change of page writes no marker, and the paragraphs on either side stand separated by a blank line.