Configuration Reference¶

Complete reference for all conversion options available across all language bindings.

Option Naming Conventions¶

Options use different naming conventions depending on the language:

Heading & Structure Options¶

heading_style¶

Controls how heading elements (h1-h6) are rendered in the Markdown output.

code_block_style¶

Controls how code blocks (<pre><code>) are rendered.

code_language¶

Default language for fenced code blocks when no language is specified in the HTML.

Type: string | Default: "" (empty)

highlight_style¶

Controls how <mark> elements are rendered.

output_format v2.23.0¶

Target markup format for conversion.

List Options¶

bullets¶

Bullet characters for unordered lists. A string where each character is used for successive nesting levels.

Type: string | Default: "-" (Rust), "*+-" (Python/Ruby)

list_indent_type¶

Controls whether list items are indented with spaces or tabs.

list_indent_width¶

Number of spaces per indentation level for nested lists.

Type: integer | Default: 2 (Rust), 4 (Python/Ruby)

Text & Escaping Options¶

strong_em_symbol¶

Character used for strong (**) and emphasis (*) rendering.

Type: char | Default: '*'

escape_asterisks¶

Escape * characters in text content to prevent accidental Markdown formatting.

Type: boolean | Default: false

escape_underscores¶

Escape _ characters in text content to prevent accidental Markdown formatting.

Type: boolean | Default: false

escape_misc¶

Escape miscellaneous Markdown characters: \ & < [ ] > ~ # = + | -.

Type: boolean | Default: false

escape_ascii¶

Escape all ASCII punctuation characters for full CommonMark spec compliance.

Type: boolean | Default: false

Whitespace & Wrapping Options¶

whitespace_mode¶

Controls how whitespace sequences are handled.

strip_newlines¶

Strip newline characters from HTML before processing.

Type: boolean | Default: false

wrap¶

Enable automatic text wrapping at wrap_width.

Type: boolean | Default: false

wrap_width¶

Text wrapping width in characters when wrap is enabled.

Type: integer | Default: 80

newline_style¶

Controls how soft line breaks (from <br>) are rendered in Markdown.

Content Filtering Options¶

preserve_tags v2.5.0¶

HTML tags to preserve as-is in the output (keep original HTML, no Markdown conversion).

Type: string[] | Default: []

Example: ["table", "div", "iframe"]

strip_tags¶

HTML tags to strip (extract inner text content only, no Markdown conversion for the tag itself).

Type: string[] | Default: []

skip_images v2.21.0¶

Skip all <img> elements during conversion, omitting them entirely from output.

Type: boolean | Default: false

keep_inline_images_in¶

HTML element contexts where images should remain as Markdown image links rather than being converted to alt text.

Type: string[] | Default: []

Link & URL Options¶

autolinks¶

Use autolink syntax for bare URLs: <http://example.com>.

Type: boolean | Default: true

default_title¶

Add a default title element to the HTML if none exists before conversion.

Type: boolean | Default: false

Table Options¶

br_in_tables v2.22.4¶

Use HTML <br> elements in tables instead of spaces for line breaks.

Type: boolean | Default: false

hocr_spatial_tables¶

Enable spatial table reconstruction in hOCR documents via positioning analysis.

Type: boolean | Default: true

Symbol Options¶

sub_symbol¶

Custom symbol for subscript content (<sub>). When empty, subscript is rendered with HTML tags.

Type: string | Default: "" (empty -- uses HTML)

sup_symbol¶

Custom symbol for superscript content (<sup>). When empty, superscript is rendered with HTML tags.

Type: string | Default: "" (empty -- uses HTML)

Preprocessing Options¶

preprocessing¶

HTML preprocessing configuration for cleaning up input before conversion.

PreprocessingOptions {
    enabled: bool,              // default: false
    preset: string,             // "default" | "aggressive"
    remove_navigation: bool,    // default: false
    remove_forms: bool,         // default: false
}

Advanced Options¶

convert_as_inline¶

Treat block-level elements as inline during conversion.

Type: boolean | Default: false

extract_metadata¶

Enable metadata extraction during conversion.

Type: boolean | Default: true

encoding¶

Source document encoding (informational).

Type: string | Default: "utf-8"

debug¶

Enable debug mode with diagnostic warnings on conversion issues.

Type: boolean | Default: false

Language-Specific Examples¶

use html_to_markdown_rs::{ConversionOptions, HeadingStyle, CodeBlockStyle};

let options = ConversionOptions {
    heading_style: HeadingStyle::Atx,
    code_block_style: CodeBlockStyle::Backticks,
    wrap: true,
    wrap_width: 80,
    preserve_tags: vec!["table".to_string()],
    ..Default::default()
};

from html_to_markdown import ConversionOptions

options = ConversionOptions(
    heading_style="atx",
    code_block_style="backticks",
    wrap=True,
    wrap_width=80,
    preserve_tags=["table"],
)

const options = {
  headingStyle: "atx",
  codeBlockStyle: "backticks",
  wrap: true,
  wrapWidth: 80,
  preserveTags: ["table"],
};

options = {
  heading_style: "atx",
  code_block_style: "backticks",
  wrap: true,
  wrap_width: 80,
  preserve_tags: ["table"],
}

$options = new ConversionOptions(
    headingStyle: 'atx',
    codeBlockStyle: 'backticks',
    wrap: true,
    wrapWidth: 80,
    preserveTags: ['table'],
);

options = %{
  heading_style: "atx",
  code_block_style: "backticks",
  wrap: true,
  wrap_width: 80,
  preserve_tags: ["table"]
}

options <- list(
  heading_style = "atx",
  code_block_style = "backticks",
  wrap = TRUE,
  wrap_width = 80,
  preserve_tags = c("table")
)

See Also¶

• Types Reference -- MetadataConfig, ExtendedMetadata, and other types
• Basic Conversion Guide -- getting started