MarkdownSettings
Settings for Markdown. Values fall back through three levels: document → SDK → built-in default. Writes target the document only when set on a document’s settings, otherwise the SDK globally when set on SdkSettings.
using Nutrient;The SDK creates this class through factory methods or other SDK objects.
Properties
EmitFigurePlaceholders
public bool EmitFigurePlaceholders { get; set; }Controls whether pictures that have no alt text and no extractable words emit a [Figure] placeholder line in the Markdown output. When enabled, such pictures are marked with the placeholder; when disabled, they emit nothing. Pictures with alt text are unaffected and always render as ![alt]().
Type: bool
EmitHeaderFooterMarkers
public bool EmitHeaderFooterMarkers { get; set; }Controls whether included running headers and footers are wrapped in <!-- page-header --> / <!-- page-footer --> comment markers. The markers are invisible when the Markdown is rendered and let a consumer that wants body text only strip running headers/footers with a single regex. When disabled, the header/footer text is emitted as a plain paragraph. Has no effect unless IncludeHeadersAndFooters is enabled.
Type: bool
EmitPageBoundaryMarkers
public bool EmitPageBoundaryMarkers { get; set; }When enabled, the converter emits a unique HTML-comment marker at the start of every page (<!-- nutrient-page-start: N -->, where N is the 1-indexed physical page number). The markers are invisible when the Markdown is rendered to HTML but allow downstream tooling to slice the output reliably back into per-page chunks.
Type: bool
EnableInlineFormatting
public bool EnableInlineFormatting { get; set; }Controls whether inline text formatting is preserved in the Markdown output using Markdown or inline HTML markers for bold, italic, underline, highlight, strikethrough, superscript, and subscript text.
Type: bool
EnableSemanticBlockFormatting
public bool EnableSemanticBlockFormatting { get; set; }Controls whether footnotes render as a blockquote (>) and whether pictures, charts and barcodes are emitted at all (pictures render as ![alt]() when they carry alt text; refer to EmitFigurePlaceholders for pictures without one; charts render as their table only). When false, footnotes render as plain paragraphs and pictures, charts and barcodes are dropped entirely. Captions render as plain paragraphs and list items with - regardless.
Type: bool
ExtractWordsFromPictures
public bool ExtractWordsFromPictures { get; set; }Controls whether words detected inside picture regions are emitted as plain text in Markdown output. This helps preserve chart labels, axis text, legends, and similar image-contained text when available.
Type: bool
ImageExport
public ImageExportMode ImageExport { get; set; }Controls how images are exported when converting documents to Markdown.
Type: ImageExportMode
IncludeHeadersAndFooters
public bool IncludeHeadersAndFooters { get; set; }Controls whether running page headers and footers are included in the Markdown output. When enabled, their content (agency ids, case numbers, page numbers, letterhead) is emitted so it stays available to readers and language models. Set EmitHeaderFooterMarkers to also wrap it in comment markers.
Type: bool
JoinHyphenatedLineBreaks
public bool JoinHyphenatedLineBreaks { get; set; }Controls whether a word the source document broke across a visual line with a wrap hyphen is rejoined in the Markdown output (concen- + trations becomes concentrations, while a compound’s own hyphen at the wrap, quasi- + experimental, is kept). The decision uses the language’s lexicon pack when one is available. When disabled, the fragments are emitted as they appear in the source, separated by a space.
Type: bool
UseHtmlTables
public bool UseHtmlTables { get; set; }Controls how tables are rendered in the Markdown output. When enabled, tables are emitted as HTML (<table>/<tr>/<td>) preserving row/column spans where available; when disabled, tables render as pipe-style Markdown.
Type: bool
Resource management
public void Dispose()MarkdownSettings implements IDisposable. Call Dispose() or use a C# using declaration to release its native handle right away. If you don’t, the handle is released when the object is garbage collected.