Ruby API Reference

Ruby API Reference v3.8.3

Functions

convert()

Convert HTML to Markdown, Djot, or plain text.

Returns a ConversionResult with converted content plus optional metadata, document structure, table data, inline images, and warnings depending on the enabled features and conversion options.

Some(options), or nil. Language bindings expose the same option fields through native constructors or optional parameters.

Errors:

Returns an error if HTML parsing fails or if the input contains invalid UTF-8.

Signature:

def self.convert(html, options: nil)

Example:

result = convert("value", options: ConversionOptions.new)

Parameters:

Name	Type	Required	Description
`html`	`String`	Yes	The html
`options`	`ConversionOptions?`	No	The options to use

Returns: ConversionResult

Errors: Raises Error.

Types

ConversionOptions

Main conversion options for HTML to Markdown conversion.

Use ConversionOptions.builder() to construct, or the default constructor for defaults.

Field	Type	Default	Description
`heading_style`	`HeadingStyle`	`:atx`	Heading style to use in Markdown output (ATX `#` or Setext underline).
`list_indent_type`	`ListIndentType`	`:spaces`	How to indent nested list items (spaces or tab).
`list_indent_width`	`Integer`	`2`	Number of spaces (or tabs) to use for each level of list indentation.
`bullets`	`String`	`"-*+"`	Bullet character(s) to use for unordered list items (e.g. `"-"`, `"*"`).
`strong_em_symbol`	`String`	`"*"`	Character used for bold/italic emphasis markers (`*` or `_`).
`escape_asterisks`	`Boolean`	`false`	Escape `*` characters in plain text to avoid unintended bold/italic.
`escape_underscores`	`Boolean`	`false`	Escape `_` characters in plain text to avoid unintended bold/italic.
`escape_misc`	`Boolean`	`false`	Escape miscellaneous Markdown metacharacters (`\[\]()#` etc.) in plain text.
`escape_ascii`	`Boolean`	`false`	Escape ASCII characters that have special meaning in certain Markdown dialects.
`code_language`	`String`	`""`	Default language annotation for fenced code blocks that have no language hint.
`autolinks`	`Boolean`	`true`	Automatically convert bare URLs into Markdown autolinks.
`default_title`	`Boolean`	`false`	Emit a default title when no `<title>` tag is present.
`br_in_tables`	`Boolean`	`false`	Render `<br>` elements inside table cells as literal line breaks.
`compact_tables`	`Boolean`	`false`	Emit tables without column padding (compact GFM format). When `true`, column widths are not computed and cells are emitted with no trailing spaces. Separator rows use exactly `---` per column. Produces token-efficient output suitable for RAG / LLM contexts. Default `false` (aligned padding preserved).
`highlight_style`	`HighlightStyle`	`:double_equal`	Style used for `<mark>` / highlighted text (e.g. `==text==`).
`extract_metadata`	`Boolean`	`true`	Populate `result.metadata` with `<head>` / `<meta>` extraction (title, description, Open Graph, Twitter Card, JSON-LD, …). Default `true`. Disabling skips the metadata pass only — table extraction into `result.tables` runs unconditionally.
`whitespace_mode`	`WhitespaceMode`	`:normalized`	Controls how whitespace sequences are normalised in the converted output. - `WhitespaceMode.Normalized` (default) — collapses consecutive whitespace characters (spaces, tabs, newlines) to a single space, matching browser rendering behaviour. - `WhitespaceMode.Strict` — preserves all whitespace exactly as it appears in the source HTML, including runs of spaces and embedded newlines. Choose `Strict` only when the source HTML uses deliberate whitespace (e.g. pre-formatted content outside `<pre>` tags). For most documents `Normalized` produces cleaner output.
`strip_newlines`	`Boolean`	`false`	Strip all newlines from the output, producing a single-line result.
`wrap`	`Boolean`	`false`	Wrap long lines at `wrap_width` characters.
`wrap_width`	`Integer`	`80`	Maximum output line width in characters when `wrap` is `true` (default `80`). Lines are broken at word boundaries so that no line exceeds this length. A value of `0` is treated as “no limit” — equivalent to leaving `wrap` disabled. Has no effect when `wrap` is `false`.
`convert_as_inline`	`Boolean`	`false`	Treat the entire document as inline content (no block-level wrappers).
`sub_symbol`	`String`	`""`	Markdown notation for subscript text (e.g. `"~"`).
`sup_symbol`	`String`	`""`	Markdown notation for superscript text (e.g. `"^"`).
`newline_style`	`NewlineStyle`	`:spaces`	How to encode hard line breaks (`<br>`) in Markdown.
`code_block_style`	`CodeBlockStyle`	`:backticks`	Style used for fenced code blocks (backticks or tilde).
`keep_inline_images_in`	`Array<String>`	`\[\]`	HTML tag names whose `<img>` children are kept inline instead of block.
`preprocessing`	`PreprocessingOptions`	—	Options for the HTML pre-processing pass applied before conversion begins. Pre-processing runs before the HTML is handed to the converter and can perform operations such as unwrapping redundant wrapper elements, removing tracking pixels, and normalising vendor-specific markup. See `PreprocessingOptions` for the full set of knobs. Defaults to the standard preprocessing options, which enables the standard cleaning passes. Set individual fields on `PreprocessingOptions` (or construct via `ConversionOptions.builder`) to opt in or out of specific passes.
`encoding`	`String`	`"utf-8"`	Expected character encoding of the input HTML (default `"utf-8"`).
`debug`	`Boolean`	`false`	Emit debug information during conversion.
`strip_tags`	`Array<String>`	`\[\]`	HTML tag names whose content is stripped from the output entirely.
`preserve_tags`	`Array<String>`	`\[\]`	HTML tag names that are preserved verbatim in the output.
`skip_images`	`Boolean`	`false`	Skip conversion of `<img>` elements (omit images from output).
`url_escape_style`	`UrlEscapeStyle`	`:angle`	URL encoding strategy for link and image destinations. Controls how special characters in URL destinations are escaped: - `UrlEscapeStyle.Angle` (default) — wraps the destination in angle brackets when it contains spaces or newlines. Some parsers misinterpret `>` inside such a destination. - `UrlEscapeStyle.Percent` — percent-encodes every character that is not an RFC 3986 unreserved character or `/`, producing a destination that all Markdown parsers handle correctly even when the URL contains `<`, `>`, spaces, or parentheses.
`link_style`	`LinkStyle`	`:inline`	Link rendering style (inline or reference).
`output_format`	`OutputFormat`	`:markdown`	Target output format (Markdown, plain text, etc.).
`include_document_structure`	`Boolean`	`false`	Include structured document tree in result.
`extract_images`	`Boolean`	`false`	Extract inline images from data URIs and SVGs.
`max_image_size`	`Integer`	`5242880`	Maximum decoded image size in bytes (default 5MB).
`capture_svg`	`Boolean`	`false`	Capture SVG elements as images.
`infer_dimensions`	`Boolean`	`true`	Infer image dimensions from data.
`max_depth`	`Integer?`	`nil`	Maximum DOM traversal depth. `nil` uses the library’s internal native-stack safety limit. Explicit values above that safety limit are clamped to prevent process-aborting stack overflows on pathologically deep DOM trees.
`exclude_selectors`	`Array<String>`	`\[\]`	CSS selectors for elements to exclude entirely (element + all content). Unlike `strip_tags` (which removes the tag wrapper but keeps children), excluded elements and all their descendants are dropped from the output. Supports any CSS selector that `tl` supports: tag names, `.class`, `#id`, `\[attribute\]`, etc. Invalid selectors are silently skipped at conversion time. Example: `\[".cookie-banner", "#ad-container", "\[role='complementary'\]"\]`
`tier_strategy`	`TierStrategy`	`:auto`	Which conversion tier to use. - `TierStrategy.Auto` (default) — automatically choose the best path. - `TierStrategy.Tier2` — always use the Tier-2 DOM-walk path. - `TierStrategy.Tier1` — always attempt Tier-1 (testkit only).
`visitor`	`VisitorHandle?`	`nil`	Optional visitor for custom traversal logic. When set, the visitor’s callbacks are invoked for matching HTML elements during conversion, allowing custom output, skipping, or HTML preservation. See `HtmlVisitor`.

Methods

default()

Signature:

def self.default()

Example:

result = ConversionOptions.default()

Returns: ConversionOptions

ConversionResult

The primary result of HTML conversion and extraction.

Contains the converted text output, optional structured document tree, metadata, extracted tables, images, and processing warnings.

Field	Type	Default	Description
`content`	`String?`	`nil`	Converted text output in the selected format: Markdown, Djot, or plain text.
`document`	`DocumentStructure?`	`nil`	Structured document tree with semantic elements. Populated when the `include_document_structure` option is `true`. `nil` otherwise (the default), which avoids the overhead of building the tree. When present, the tree mirrors the converted document: headings open `Group` sections, paragraphs and list items carry inline `TextAnnotation`s, and tables reference the same `TableGrid` data exposed in the result’s `tables` field. Note: this field is independent of the `metadata` feature flag. Document structure collection is always available at runtime; it is gated only by the runtime option, not by a compile-time feature.
`metadata`	`HtmlMetadata`	—	Extracted HTML metadata (title, OG, links, images, structured data).
`tables`	`Array<TableData>`	`\[\]`	Extracted tables with structured cell data and markdown representation.
`warnings`	`Array<ProcessingWarning>`	`\[\]`	Non-fatal processing warnings.

DocumentMetadata

Document-level metadata extracted from <head> and top-level elements.

Contains all metadata typically used by search engines, social media platforms, and browsers for document indexing and presentation.

Field	Type	Default	Description
`title`	`String?`	`nil`	Document title from `<title>` tag
`description`	`String?`	`nil`	Document description from `<meta name="description">` tag
`keywords`	`Array<String>`	`\[\]`	Document keywords from `<meta name="keywords">` tag, split on commas
`author`	`String?`	`nil`	Document author from `<meta name="author">` tag
`canonical_url`	`String?`	`nil`	Canonical URL from `<link rel="canonical">` tag
`base_href`	`String?`	`nil`	Base URL from `<base href="">` tag for resolving relative URLs
`language`	`String?`	`nil`	Document language from `lang` attribute
`text_direction`	`TextDirection?`	`nil`	Document text direction from `dir` attribute
`open_graph`	`Hash{String=>String}`	`{}`	Open Graph metadata (og:* properties) for social media Keys like “title”, “description”, “image”, “url”, etc.
`twitter_card`	`Hash{String=>String}`	`{}`	Twitter Card metadata (twitter:* properties) Keys like “card”, “site”, “creator”, “title”, “description”, “image”, etc.
`meta_tags`	`Hash{String=>String}`	`{}`	Additional meta tags not covered by specific fields Keys are meta name/property attributes, values are content

DocumentNode

A single node in the document tree.

Field	Type	Default	Description
`id`	`String`	—	Deterministic node identifier.
`content`	`NodeContent`	—	The semantic content of this node.
`parent`	`Integer?`	`nil`	Index of the parent node (None for root nodes).
`children`	`Array<Integer>`	`/* serde(default) */`	Indices of child nodes in reading order.
`annotations`	`Array<TextAnnotation>`	`/* serde(default) */`	Inline formatting annotations (bold, italic, links, etc.) with byte offsets into the text.
`attributes`	`Hash{String=>String}?`	`nil`	Format-specific attributes preserved from the source HTML element. Keys are lowercased attribute names as they appear in the HTML (e.g. `"class"`, `"id"`, `"data-foo"`). Values are the raw attribute strings, copied verbatim from the source — no HTML entity decoding is applied here. The map is `nil` when no attributes are present (omitted entirely in serialized output). Not every HTML attribute is preserved: only attributes that carry semantic or structural significance for the node type are collected. For example, heading nodes capture the `"id"` attribute for anchor linking; other element-level attributes may be silently dropped.

DocumentStructure

A structured document tree representing the semantic content of an HTML document.

Uses a flat node array with index-based parent/child references for efficient traversal.

Field	Type	Default	Description
`nodes`	`Array<DocumentNode>`	—	All nodes in document reading order.
`source_format`	`String?`	`nil`	The source format (always “html” for this library).

GridCell

A single cell in a table grid.

Field	Type	Default	Description
`content`	`String`	—	The text content of the cell.
`row`	`Integer`	—	0-indexed row position.
`col`	`Integer`	—	0-indexed column position.
`row_span`	`Integer`	`serde(default = "default_span")`	Number of rows this cell spans (default 1).
`col_span`	`Integer`	`serde(default = "default_span")`	Number of columns this cell spans (default 1).
`is_header`	`Boolean`	`/* serde(default) */`	Whether this is a header cell (`<th>`).

HeaderMetadata

Header element metadata with hierarchy tracking.

Captures heading elements (h1-h6) with their text content, identifiers, and position in the document structure.

Field	Type	Default	Description
`level`	`Integer`	—	Header level: 1 (h1) through 6 (h6)
`text`	`String`	—	Normalized text content of the header
`id`	`String?`	`nil`	HTML id attribute if present
`depth`	`Integer`	—	Document tree depth at the header element
`html_offset`	`Integer`	—	Byte offset in original HTML document

Methods

is_valid()

Validate that the header level is within valid range (1-6).

Returns:

true if level is 1-6, false otherwise.

Signature:

def is_valid()

Example:

result = instance.is_valid()

Returns: Boolean

HtmlMetadata

Comprehensive metadata extraction result from HTML document.

Contains all extracted metadata types in a single structure, suitable for serialization and transmission across language boundaries.

Field	Type	Default	Description
`document`	`DocumentMetadata`	—	Document-level metadata (title, description, canonical, etc.)
`headers`	`Array<HeaderMetadata>`	`\[\]`	Extracted header elements with hierarchy
`links`	`Array<LinkMetadata>`	`\[\]`	Extracted hyperlinks with type classification
`images`	`Array<ImageMetadata>`	`\[\]`	Extracted images with source and dimensions
`structured_data`	`Array<StructuredData>`	`\[\]`	Extracted structured data blocks

HtmlVisitor

Visitor for HTML→Markdown conversion.

Provide a visitor object whose methods customize the conversion behavior for any HTML element type. Override only the methods you care about; unimplemented methods default to Continue (emit the standard rendering).

Each callback returns one of:

Continue (the default) — keep the standard rendering.
Skip — drop the element from the output entirely.
PreserveHtml — pass the original HTML through verbatim.
Custom(text) — replace the rendering with text.
Error(message) — abort conversion with message.

Language idioms. In Rust, return one of the VisitResult variants directly. In Python, Ruby, JavaScript/TypeScript, and other duck-typed bindings, define a plain class (no base class required) and return either a string ("continue", "skip", "preserve_html") or a tagged map ({"custom": "..."}, {"error": "..."}) — the binding converts the return value to the corresponding VisitResult variant automatically.

Method Naming Convention

visit_*_start: Called before entering an element (pre-order traversal)
visit_*_end: Called after exiting an element (post-order traversal)
visit_*: Called for specific element types (e.g., visit_link, visit_image)

Execution Order

For a typical element like <div><p>text</p></div>:

visit_element_start for <div>
visit_element_start for <p>
visit_text for “text”
visit_element_end for <p>
visit_element_end for </div>

Performance Notes

visit_text is the most frequently called method (~100+ times per document)
Return Continue quickly for elements you don’t need to customize
Avoid heavy computation in visitor methods; consider caching if needed

Methods

visit_text()

Visit text nodes (most frequent callback - ~100+ per document).

Signature:

def visit_text(ctx, text)

Example:

result = instance.visit_text(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_element_start()

Called before entering any element.

This is the first callback invoked for every HTML element, allowing visitors to implement generic element handling before tag-specific logic.

Signature:

def visit_element_start(ctx)

Example:

result = instance.visit_element_start(NodeContext.new)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context

Returns: VisitResult

visit_element_end()

Called after exiting any element.

Receives the default markdown output that would be generated. Visitors can inspect or replace this output.

Signature:

def visit_element_end(ctx, output)

Example:

result = instance.visit_element_end(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`output`	`String`	Yes	The output

Returns: VisitResult

visit_link()

Visit anchor links <a href="...">.

Signature:

def visit_link(ctx, href, text, title)

Example:

result = instance.visit_link(NodeContext.new, "value", "value", title: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`href`	`String`	Yes	The href
`text`	`String`	Yes	The text
`title`	`String?`	No	The title

Returns: VisitResult

visit_image()

Visit images <img src="...">.

Signature:

def visit_image(ctx, src, alt, title)

Example:

result = instance.visit_image(NodeContext.new, "value", "value", title: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`src`	`String`	Yes	The src
`alt`	`String`	Yes	The alt
`title`	`String?`	No	The title

Returns: VisitResult

visit_heading()

Visit heading elements <h1> through <h6>.

Signature:

def visit_heading(ctx, level, text, id)

Example:

result = instance.visit_heading(NodeContext.new, 42, "value", id: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`level`	`Integer`	Yes	The level
`text`	`String`	Yes	The text
`id`	`String?`	No	The id

Returns: VisitResult

visit_code_block()

Visit code blocks <pre><code>.

Signature:

def visit_code_block(ctx, lang, code)

Example:

result = instance.visit_code_block(NodeContext.new, lang: "value", "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`lang`	`String?`	No	The lang
`code`	`String`	Yes	The code

Returns: VisitResult

visit_code_inline()

Visit inline code <code>.

Signature:

def visit_code_inline(ctx, code)

Example:

result = instance.visit_code_inline(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`code`	`String`	Yes	The code

Returns: VisitResult

visit_list_item()

Visit list items <li>.

Signature:

def visit_list_item(ctx, ordered, marker, text)

Example:

result = instance.visit_list_item(NodeContext.new, true, "value", "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`ordered`	`Boolean`	Yes	The ordered
`marker`	`String`	Yes	The marker
`text`	`String`	Yes	The text

Returns: VisitResult

visit_list_start()

Called before processing a list <ul> or <ol>.

Signature:

def visit_list_start(ctx, ordered)

Example:

result = instance.visit_list_start(NodeContext.new, true)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`ordered`	`Boolean`	Yes	The ordered

Returns: VisitResult

visit_list_end()

Called after processing a list </ul> or </ol>.

Signature:

def visit_list_end(ctx, ordered, output)

Example:

result = instance.visit_list_end(NodeContext.new, true, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`ordered`	`Boolean`	Yes	The ordered
`output`	`String`	Yes	The output

Returns: VisitResult

visit_table_start()

Called before processing a table <table>.

Signature:

def visit_table_start(ctx)

Example:

result = instance.visit_table_start(NodeContext.new)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context

Returns: VisitResult

visit_table_row()

Visit table rows <tr>.

Signature:

def visit_table_row(ctx, cells, is_header)

Example:

result = instance.visit_table_row(NodeContext.new, [], true)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`cells`	`Array<String>`	Yes	The cells
`is_header`	`Boolean`	Yes	The is header

Returns: VisitResult

visit_table_end()

Called after processing a table </table>.

Signature:

def visit_table_end(ctx, output)

Example:

result = instance.visit_table_end(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`output`	`String`	Yes	The output

Returns: VisitResult

visit_blockquote()

Visit blockquote elements <blockquote>.

Signature:

def visit_blockquote(ctx, content, depth)

Example:

result = instance.visit_blockquote(NodeContext.new, "value", 42)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`content`	`String`	Yes	The content
`depth`	`Integer`	Yes	The depth

Returns: VisitResult

visit_strong()

Visit strong/bold elements <strong>, <b>.

Signature:

def visit_strong(ctx, text)

Example:

result = instance.visit_strong(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_emphasis()

Visit emphasis/italic elements <em>, <i>.

Signature:

def visit_emphasis(ctx, text)

Example:

result = instance.visit_emphasis(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_strikethrough()

Visit strikethrough elements <s>, <del>, <strike>.

Signature:

def visit_strikethrough(ctx, text)

Example:

result = instance.visit_strikethrough(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_underline()

Visit underline elements <u>, <ins>.

Signature:

def visit_underline(ctx, text)

Example:

result = instance.visit_underline(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_subscript()

Visit subscript elements <sub>.

Signature:

def visit_subscript(ctx, text)

Example:

result = instance.visit_subscript(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_superscript()

Visit superscript elements <sup>.

Signature:

def visit_superscript(ctx, text)

Example:

result = instance.visit_superscript(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_mark()

Visit mark/highlight elements <mark>.

Signature:

def visit_mark(ctx, text)

Example:

result = instance.visit_mark(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_line_break()

Visit line break elements <br>.

Signature:

def visit_line_break(ctx)

Example:

result = instance.visit_line_break(NodeContext.new)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context

Returns: VisitResult

visit_horizontal_rule()

Visit horizontal rule elements <hr>.

Signature:

def visit_horizontal_rule(ctx)

Example:

result = instance.visit_horizontal_rule(NodeContext.new)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context

Returns: VisitResult

visit_custom_element()

Visit custom elements (web components) or unknown tags.

Signature:

def visit_custom_element(ctx, tag_name, html)

Example:

result = instance.visit_custom_element(NodeContext.new, "value", "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`tag_name`	`String`	Yes	The tag name
`html`	`String`	Yes	The html

Returns: VisitResult

visit_definition_list_start()

Visit definition list <dl>.

Signature:

def visit_definition_list_start(ctx)

Example:

result = instance.visit_definition_list_start(NodeContext.new)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context

Returns: VisitResult

visit_definition_term()

Visit definition term <dt>.

Signature:

def visit_definition_term(ctx, text)

Example:

result = instance.visit_definition_term(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_definition_description()

Visit definition description <dd>.

Signature:

def visit_definition_description(ctx, text)

Example:

result = instance.visit_definition_description(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_definition_list_end()

Called after processing a definition list </dl>.

Signature:

def visit_definition_list_end(ctx, output)

Example:

result = instance.visit_definition_list_end(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`output`	`String`	Yes	The output

Returns: VisitResult

visit_form()

Visit form elements <form>.

Signature:

def visit_form(ctx, action, method)

Example:

result = instance.visit_form(NodeContext.new, action: "value", method: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`action`	`String?`	No	The action
`method`	`String?`	No	The method

Returns: VisitResult

visit_input()

Visit input elements <input>.

Signature:

def visit_input(ctx, input_type, name, value)

Example:

result = instance.visit_input(NodeContext.new, "value", name: "value", value: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`input_type`	`String`	Yes	The input type
`name`	`String?`	No	The name
`value`	`String?`	No	The value

Returns: VisitResult

visit_button()

Visit button elements <button>.

Signature:

def visit_button(ctx, text)

Example:

result = instance.visit_button(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_audio()

Visit audio elements <audio>.

Signature:

def visit_audio(ctx, src)

Example:

result = instance.visit_audio(NodeContext.new, src: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`src`	`String?`	No	The src

Returns: VisitResult

visit_video()

Visit video elements <video>.

Signature:

def visit_video(ctx, src)

Example:

result = instance.visit_video(NodeContext.new, src: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`src`	`String?`	No	The src

Returns: VisitResult

visit_iframe()

Visit iframe elements <iframe>.

Signature:

def visit_iframe(ctx, src)

Example:

result = instance.visit_iframe(NodeContext.new, src: "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`src`	`String?`	No	The src

Returns: VisitResult

visit_details()

Visit details elements <details>.

Signature:

def visit_details(ctx, open)

Example:

result = instance.visit_details(NodeContext.new, true)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`open`	`Boolean`	Yes	The open

Returns: VisitResult

visit_summary()

Visit summary elements <summary>.

Signature:

def visit_summary(ctx, text)

Example:

result = instance.visit_summary(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_figure_start()

Visit figure elements <figure>.

Signature:

def visit_figure_start(ctx)

Example:

result = instance.visit_figure_start(NodeContext.new)

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context

Returns: VisitResult

visit_figcaption()

Visit figcaption elements <figcaption>.

Signature:

def visit_figcaption(ctx, text)

Example:

result = instance.visit_figcaption(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`text`	`String`	Yes	The text

Returns: VisitResult

visit_figure_end()

Called after processing a figure </figure>.

Signature:

def visit_figure_end(ctx, output)

Example:

result = instance.visit_figure_end(NodeContext.new, "value")

Parameters:

Name	Type	Required	Description
`ctx`	`NodeContext`	Yes	The node context
`output`	`String`	Yes	The output

Returns: VisitResult

ImageDimensions

Image dimensions in pixels.

Binding-safe replacement for (u32, u32) tuples, which degrade to Array<Array<String>> when sanitized for cross-language binding generation. Used by both ImageMetadata and InlineImage.

Field	Type	Default	Description
`width`	`Integer`	—	Width in pixels.
`height`	`Integer`	—	Height in pixels.

ImageMetadata

Image metadata with source and dimensions.

Captures <img> elements and inline <svg> elements with metadata for image analysis and optimization.

Field	Type	Default	Description
`src`	`String`	—	Image source (URL, data URI, or SVG content identifier)
`alt`	`String?`	`nil`	Alternative text from alt attribute (for accessibility)
`title`	`String?`	`nil`	Title attribute (often shown as tooltip)
`dimensions`	`ImageDimensions?`	`nil`	Image dimensions in pixels, if available.
`image_type`	`ImageType`	—	Image type classification
`attributes`	`Hash{String=>String}`	—	Additional HTML attributes

LinkMetadata

Hyperlink metadata with categorization and attributes.

Represents <a> elements with parsed href values, text content, and link type classification.

Field	Type	Default	Description
`href`	`String`	—	The href URL value
`text`	`String`	—	Link text content (normalized, concatenated if mixed with elements)
`title`	`String?`	`nil`	Optional title attribute (often shown as tooltip)
`link_type`	`LinkType`	—	Link type classification
`rel`	`Array<String>`	—	Rel attribute values (e.g., “nofollow”, “stylesheet”, “canonical”)
`attributes`	`Hash{String=>String}`	—	Additional HTML attributes

MetadataEntry

A single key-value metadata entry from <head> meta tags.

Binding-safe replacement for (String, String) tuples used in NodeContent.MetadataBlock. Tuple pairs cannot be represented across language boundaries without lossy degradation.

Field	Type	Default	Description
`key`	`String`	—	Metadata key (e.g. `"title"`, `"description"`, `"og:title"`).
`value`	`String`	—	Metadata value.

NodeContext

Context information passed to all visitor methods.

Provides comprehensive metadata about the current node being visited, including its type, tag name, position in the DOM tree, and parent context.

Attributes

Access attributes via NodeContext.attributes, which returns Hash{String=>String}. When the context was built with lazy attribute extraction (the hot path inside the converter), the map is only materialized on the first call — if the visitor never reads attributes, the allocation is skipped.

Lifetimes

String fields use Cow<'_, str> so the converter can pass slices directly out of the parsed DOM without allocating. Visitor implementations that need to outlive the callback should call NodeContext.into_owned.

Field	Type	Default	Description
`node_type`	`NodeType`	—	Coarse-grained node type classification
`tag_name`	`String`	—	Raw HTML tag name (e.g., “div”, “h1”, “custom-element”)
`depth`	`Integer`	—	Depth in the DOM tree (0 = root)
`index_in_parent`	`Integer`	—	Index among siblings (0-based)
`parent_tag`	`String?`	`nil`	Parent element’s tag name (None if root)
`is_inline`	`Boolean`	—	Whether this element is treated as inline vs block

Methods

attributes()

Return a reference to the attribute map.

If the context was built with lazy attribute extraction, the map is materialized on the first call and cached for subsequent calls. If this method is never called, no allocation occurs for attributes.

Signature:

def attributes()

Example:

result = instance.attributes()

Returns: Hash{String=>String}

with_owned_attributes()

Construct a NodeContext with an owned attribute map.

Use this when the caller already has materialized attributes.

Signature:

def self.with_owned_attributes(node_type, tag_name, attributes, depth, index_in_parent, parent_tag, is_inline)

Example:

result = NodeContext.with_owned_attributes(NodeType.new, "value", [], 42, 42, parent_tag: "value", true)

Parameters:

Name	Type	Required	Description
`node_type`	`NodeType`	Yes	The node type
`tag_name`	`String`	Yes	The tag name
`attributes`	`Hash{String=>String}`	Yes	The attributes
`depth`	`Integer`	Yes	The depth
`index_in_parent`	`Integer`	Yes	The index in parent
`parent_tag`	`String?`	No	The parent tag
`is_inline`	`Boolean`	Yes	The is inline

Returns: NodeContext

into_owned()

Promote any borrowed fields into owned storage so the context can outlive 'a.

Signature:

def into_owned()

Example:

result = instance.into_owned()

Returns: NodeContext

PreprocessingOptions

HTML preprocessing options for document cleanup before conversion.

Field	Type	Default	Description
`enabled`	`Boolean`	`true`	Enable HTML preprocessing globally
`preset`	`PreprocessingPreset`	`:standard`	Preprocessing preset level (Minimal, Standard, Aggressive)
`remove_navigation`	`Boolean`	`true`	Remove navigation elements (nav, breadcrumbs, menus, sidebars)
`remove_forms`	`Boolean`	`true`	Remove form elements (forms, inputs, buttons, etc.)

Methods

default()

Signature:

def self.default()

Example:

result = PreprocessingOptions.default()

Returns: PreprocessingOptions

ProcessingWarning

A non-fatal diagnostic produced during HTML conversion.

Warnings indicate that conversion completed but some content may have been handled differently than expected — for example, an image that could not be extracted, a truncated input, or malformed HTML that was repaired with best-effort parsing.

Conversion always succeeds (returns ConversionResult) even when warnings are present. Callers should inspect warnings and decide how to handle them based on their tolerance for partial results:

Logging pipelines: emit each warning at WARN level and continue.
Strict pipelines: treat any warning as a hard error by checking result.warnings.is_empty() before using the output.

See WarningKind for the full taxonomy of warning categories.

Field	Type	Default	Description
`message`	`String`	—	Human-readable warning message.
`kind`	`WarningKind`	—	The category of warning.

StructuredData

Structured data block (JSON-LD, Microdata, or RDFa).

Represents machine-readable structured data found in the document. JSON-LD blocks are collected as raw JSON strings for flexibility.

Field	Type	Default	Description
`data_type`	`StructuredDataType`	—	Type of structured data (JSON-LD, Microdata, `RDFa`)
`raw_json`	`String`	—	Raw JSON string (for JSON-LD) or serialized representation
`schema_type`	`String?`	`nil`	Schema type if detectable (e.g., “Article”, “Event”, “Product”)

TableData

A top-level extracted table with both structured data and markdown representation.

Field	Type	Default	Description
`grid`	`TableGrid`	—	The structured table grid.
`markdown`	`String`	—	The markdown rendering of this table.

TableGrid

A structured table grid with cell-level data including spans.

Field	Type	Default	Description
`rows`	`Integer`	—	Number of rows.
`cols`	`Integer`	—	Number of columns.
`cells`	`Array<GridCell>`	`\[\]`	All cells in the table as a flat, sparse list. The list is ordered by `(row, col)` but is not a dense `rows × cols` matrix: cells that are covered by a spanning cell (via `row_span > 1` or `col_span > 1`) do not appear in the list. Only the top-left “origin” cell of a span is present, with its `row_span` and `col_span` fields set accordingly. To reconstruct the full visual grid, iterate over all cells and mark the rectangular region `\[row .. row+row_span, col .. col+col_span\]` as occupied by that cell. Any `(row, col)` position that is not the origin of any cell is covered by a span from an earlier cell. The length of this list is `≤ rows * cols`. An empty table (`rows == 0 \|\| cols == 0`) produces an empty list.

TextAnnotation

A styling or semantic annotation that applies to a byte range within a node’s text.

Unlike DocumentNode, which captures block-level structure (headings, paragraphs, etc.), a TextAnnotation describes inline-level markup — bold, italic, links, code spans, and similar — that spans a contiguous run of bytes inside DocumentNode.content’s text field.

Byte offsets (start..end) are into the UTF-8 encoded text of the parent node. The range is half-open: start is inclusive and end is exclusive.

Multiple annotations on the same node can overlap (e.g. bold-italic text), and they are stored in the order they are encountered during DOM traversal.

See AnnotationKind for the full list of supported annotation types.

Field	Type	Default	Description
`start`	`Integer`	—	Start byte offset (inclusive) into the parent node’s text.
`end`	`Integer`	—	End byte offset (exclusive) into the parent node’s text.
`kind`	`AnnotationKind`	—	The type of annotation.

VisitorHandle

Shareable, thread-safe handle to a user-provided HTML visitor implementation.

Pass an instance wrapped in this handle to ConversionOptions to customise how the HTML document is traversed and converted to Markdown. The handle may be cloned and shared across threads without additional synchronisation on the caller’s side.

Enums

TextDirection

Text directionality of document content.

Corresponds to the HTML dir attribute and bdi element directionality.

Value	Description
`left_to_right`	Left-to-right text flow (default for Latin scripts)
`right_to_left`	Right-to-left text flow (Hebrew, Arabic, Urdu, etc.)
`auto`	Automatic directionality detection

LinkType

Link classification based on href value and document context.

Used to categorize links during extraction for filtering and analysis.

Value	Description
`anchor`	Anchor link within same document (href starts with #)
`internal`	Internal link within same domain
`external`	External link to different domain
`email`	Email link (mailto:)
`phone`	Phone link (tel:)
`other`	Other protocol or unclassifiable

ImageType

Image source classification for proper handling and processing.

Determines whether an image is embedded (data URI), inline SVG, external, or relative.

Value	Description
`data_uri`	Data URI embedded image (base64 or other encoding)
`inline_svg`	Inline SVG element
`external`	External image URL (http/https)
`relative`	Relative image path

StructuredDataType

Structured data format type.

Identifies the schema/format used for structured data markup.

Value	Description
`json_ld`	JSON-LD (JSON for Linking Data) script blocks
`microdata`	HTML5 Microdata attributes (itemscope, itemtype, itemprop)
`rdfa`	RDF in Attributes (`RDFa`) markup

TierStrategy

Controls which conversion tier is used.

Value	Description
`auto`	Automatically pick the best tier for the input (default). Runs the classifier against the prescan report and uses Tier-1 when eligible; falls back to Tier-2 on bail or when the classifier routes to Tier-2.
`tier2`	Always use the Tier-2 (`tl.parse` + walk) path, skipping Tier-1.
`tier1`	Force the Tier-1 byte scanner; if it bails, fall back to Tier-2. Testkit-only; not stable API.

PreprocessingPreset

HTML preprocessing aggressiveness level.

Controls the extent of cleanup performed before conversion. Higher levels remove more elements.

Value	Description
`minimal`	Minimal cleanup. Remove only essential noise (scripts, styles).
`standard`	Standard cleanup. Default. Removes navigation, forms, and other auxiliary content.
`aggressive`	Aggressive cleanup. Remove extensive non-content elements and structure.

HeadingStyle

Heading style options for Markdown output.

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

Value	Description
`underlined`	Underlined style (=== for h1, — for h2).
`atx`	ATX style (# for h1, ## for h2, etc.). Default.
`atx_closed`	ATX closed style (# title #, with closing hashes).

ListIndentType

List indentation character type.

Controls whether list items are indented with spaces or tabs.

Value	Description
`spaces`	Use spaces for indentation. Default. Width controlled by `list_indent_width`.
`tabs`	Use tabs for indentation.

WhitespaceMode

Whitespace handling strategy during conversion.

Determines how sequences of whitespace characters (spaces, tabs, newlines) are processed.

Value	Description
`normalized`	Collapse multiple whitespace characters to single spaces. Default. Matches browser behavior.
`strict`	Preserve all whitespace exactly as it appears in the HTML.

NewlineStyle

Line break syntax in Markdown output.

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

Value	Description
`spaces`	Two trailing spaces at end of line. Default. Standard Markdown syntax.
`backslash`	Backslash at end of line. Alternative Markdown syntax.

CodeBlockStyle

Code block fence style in Markdown output.

Determines how code blocks (<pre><code>) are rendered in Markdown.

Value	Description
`indented`	Indented code blocks (4 spaces). `CommonMark` standard.
`backticks`	Fenced code blocks with triple backticks. Default (GFM). Supports language hints.
`tildes`	Fenced code blocks with tildes (~~~). Supports language hints.

HighlightStyle

Highlight rendering style for <mark> elements.

Controls how highlighted text is rendered in Markdown output.

Value	Description
`double_equal`	Double equals syntax (==text==). Default. Pandoc-compatible.
`html`	Preserve as HTML (==text==). Original HTML tag.
`bold`	Render as bold (text). Uses strong emphasis.
`none`	Strip formatting, render as plain text. No markup.

LinkStyle

Link rendering style in Markdown output.

Controls whether links and images use inline [text](url) syntax or reference-style [text][1] syntax with definitions collected at the end.

Value	Description
`inline`	Inline links: `\[text\](url)`. Default.
`reference`	Reference-style links: `\[text\]\[1\]` with `\[1\]: url` at end of document.

UrlEscapeStyle

URL encoding strategy for link and image destinations.

Controls how special characters in URL destinations are handled when they require escaping to produce valid Markdown.

The Angle variant (default) wraps the destination in angle brackets: [text](<url with spaces>). This is the CommonMark-specified escape hatch but breaks when the URL itself contains >.

The Percent variant percent-encodes every character that is not an RFC 3986 unreserved character or /, producing a destination safe for all Markdown parsers: [text](url%20with%20spaces).

Value	Description
`angle`	Wrap destinations that contain spaces or newlines in angle brackets. Default.
`percent`	Percent-encode all characters that are not RFC 3986 unreserved or `/`.

OutputFormat

Output format for conversion.

Specifies the target markup language format for the conversion output.

Value	Description
`markdown`	Standard Markdown (`CommonMark` compatible). Default.
`djot`	Djot lightweight markup language.
`plain`	Plain text output (no markup, visible text only).

NodeContent

The semantic content type of a document node.

Uses internally tagged representation ("node_type": "heading") for JSON serialization.

Value	Description
`heading`	A heading element (h1-h6). — Fields: `level`: `Integer`, `text`: `String`
`paragraph`	A paragraph of text. — Fields: `text`: `String`
`list`	A list container (ordered or unordered). Children are `ListItem` nodes. — Fields: `ordered`: `Boolean`
`list_item`	A single list item. — Fields: `text`: `String`
`table`	A table with structured cell data. — Fields: `grid`: `TableGrid`
`image`	An image element. — Fields: `description`: `String`, `src`: `String`, `image_index`: `Integer`
`code`	A code block or inline code. — Fields: `text`: `String`, `language`: `String`
`quote`	A block quote container.
`definition_list`	A definition list container.
`definition_item`	A definition list entry with term and description. — Fields: `term`: `String`, `definition`: `String`
`raw_block`	A raw block preserved as-is (e.g. `<script>`, `<style>` content). — Fields: `format`: `String`, `content`: `String`
`metadata_block`	A block of key-value metadata pairs (from `<head>` meta tags). — Fields: `entries`: `Array<MetadataEntry>`
`group`	A section grouping container (auto-generated from heading hierarchy). — Fields: `label`: `String`, `heading_level`: `Integer`, `heading_text`: `String`

AnnotationKind

The type of an inline text annotation.

Uses internally tagged representation ("annotation_type": "bold") for JSON serialization.

Value	Description
`bold`	Bold / strong emphasis.
`italic`	Italic / emphasis.
`underline`	Underline.
`strikethrough`	Strikethrough / deleted text.
`code`	Inline code.
`subscript`	Subscript text.
`superscript`	Superscript text.
`highlight`	Highlighted / marked text.
`link`	A hyperlink sourced from an `<a href="...">` element. — Fields: `url`: `String`, `title`: `String`

WarningKind

Categories of processing warnings.

Value	Description
`image_extraction_failed`	An image could not be extracted (e.g. invalid data URI, unsupported format).
`encoding_fallback`	The input encoding was not recognized; fell back to UTF-8.
`truncated_input`	The input was truncated due to size limits.
`malformed_html`	The HTML was malformed but processing continued with best effort.
`sanitization_applied`	Sanitization was applied to remove potentially unsafe content.
`depth_limit_exceeded`	DOM traversal was truncated because `max_depth` was exceeded.

NodeType

Node type enumeration covering all HTML element types.

This enum categorizes all HTML elements that the converter recognizes, providing a coarse-grained classification for visitor dispatch.

Value	Description
`text`	Text node (most frequent - 100+ per document)
`element`	Generic element node
`heading`	Heading elements (h1-h6)
`paragraph`	Paragraph element
`div`	Generic div container
`blockquote`	Blockquote element
`pre`	Preformatted text block
`hr`	Horizontal rule
`list`	Ordered or unordered list (ul, ol)
`list_item`	List item (li)
`definition_list`	Definition list (dl)
`definition_term`	Definition term (dt)
`definition_description`	Definition description (dd)
`table`	Table element
`table_row`	Table row (tr)
`table_cell`	Table cell (td, th)
`table_header`	Table header cell (th)
`table_body`	Table body (tbody)
`table_head`	Table head (thead)
`table_foot`	Table foot (tfoot)
`link`	Anchor link (a)
`image`	Image (img)
`strong`	Strong/bold (strong, b)
`em`	Emphasis/italic (em, i)
`code`	Inline code (code)
`strikethrough`	Strikethrough (s, del, strike)
`underline`	Underline (u, ins)
`subscript`	Subscript (sub)
`superscript`	Superscript (sup)
`mark`	Mark/highlight (mark)
`small`	Small text (small)
`br`	Line break (br)
`span`	Span element
`article`	Article element
`section`	Section element
`nav`	Navigation element
`aside`	Aside element
`header`	Header element
`footer`	Footer element
`main`	Main element
`figure`	Figure element
`figcaption`	Figure caption
`time`	Time element
`details`	Details element
`summary`	Summary element
`form`	Form element
`input`	Input element
`select`	Select element
`option`	Option element
`button`	Button element
`textarea`	Textarea element
`label`	Label element
`fieldset`	Fieldset element
`legend`	Legend element
`audio`	Audio element
`video`	Video element
`picture`	Picture element
`source`	Source element
`iframe`	Iframe element
`svg`	SVG element
`canvas`	Canvas element
`ruby`	Ruby annotation
`rt`	Ruby text
`rp`	Ruby parenthesis
`abbr`	Abbreviation
`kbd`	Keyboard input
`samp`	Sample output
`var`	Variable
`cite`	Citation
`q`	Quote
`del`	Deleted text
`ins`	Inserted text
`data`	Data element
`meter`	Meter element
`progress`	Progress element
`output`	Output element
`template`	Template element
`slot`	Slot element
`html`	HTML root element
`head`	Head element
`body`	Body element
`title`	Title element
`meta`	Meta element
`link_tag`	Link element (not anchor)
`style`	Style element
`script`	Script element
`base`	Base element
`custom`	Custom element (web components) or unknown tag

VisitResult

Result of a visitor callback.

Allows visitors to control the conversion flow by either proceeding with default behavior, providing custom output, skipping elements, preserving HTML, or signaling errors.

Value	Description
`continue`	Continue with default conversion behavior
`custom`	Replace default output with custom markdown The visitor takes full responsibility for the markdown output of this node and its children. — Fields: `0`: `String`
`skip`	Skip this element entirely (don’t output anything) The element and all its children are ignored in the output.
`preserve_html`	Preserve original HTML (don’t convert to markdown) The element’s raw HTML is included verbatim in the output.
`error`	Stop conversion with an error The conversion process halts and returns this error message. — Fields: `0`: `String`

Errors

ConversionError

Errors that can occur during HTML to Markdown conversion.

Variant	Description
`parse_error`	HTML parsing error
`sanitization_error`	HTML sanitization error
`config_error`	Invalid configuration
`io_error`	I/O error — stores the error message string so the variant is FFI-safe. Use `ConversionError.from(io_error)` to convert from an operating-system I/O error.
`panic`	Internal error caught during conversion
`invalid_input`	Invalid input data
`other`	Generic conversion error