Struct MarkdownExportOptions 

pub struct MarkdownExportOptions {
    pub image_mode: ImageMode,
    pub artifacts_dir: String,
    pub layers: ContentLayers,
    pub traverse_pictures: bool,
    pub escape_html: bool,
    pub escape_underscores: bool,
    pub image_placeholder: String,
}

Options of the Markdown export (DoclingDocument::export_to_markdown_with_options, #599): the docling-core MarkdownParams the port honours beyond the image mode. Default is upstream’s default export — placeholder images, artifacts as the referenced-image directory, the body layer only, no picture traversal, HTML and underscore escaping on, <!-- image --> — so a document exported with it is byte-identical to DoclingDocument::export_to_markdown.

Fields

image_mode: ImageMode

How pictures render (MarkdownParams.image_mode): the placeholder, data: URIs when embedded, ![Image](<artifacts_dir>/image_NNNNNN.<ext>) when referenced (the bytes come back for the caller to write).

artifacts_dir: String

The directory referenced images are named under.

layers: ContentLayers

The content layers rendered (MarkdownParams.layers, export_to_markdown(included_content_layers=…)): an item on a layer outside the set is skipped, its children still walked. The default body-only set drops page headers/footers (furniture), reviewer comments (notes) and hidden sheets (invisible), as upstream does; a scanned form’s running header reads out with ContentLayers::BODY.with(ContentLayer::Furniture). The extra items render through the body’s serializers — a page header is a paragraph.

traverse_pictures: bool

CommonParams.traverse_pictures: render the text items nested in a picture (the PDF pipeline’s picture children — a bordered form laid out as one picture holds every field as a child) after the picture’s own caption and image, as upstream yields them. Off, a picture prints only its caption and image.

escape_html: bool

MarkdownParams.escape_html: &, < and > in text as &, <, > (Python’s html.escape(quote=False)). Off, R&D stays R&D.

escape_underscores: bool

MarkdownParams.escape_underscores: _ in text as \_. Off, the text keeps its underscores.

image_placeholder: String

MarkdownParams.image_placeholder: what a picture prints as when it renders no image data (the placeholder mode, or a picture without a payload); upstream’s <!-- image -->.

Trait Implementations

impl Clone for MarkdownExportOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MarkdownExportOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MarkdownExportOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MarkdownExportOptions

impl PartialEq for MarkdownExportOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MarkdownExportOptions