HtmlToMarkdown.VisitResult (html_to_markdown v3.6.0-rc.2)

Copy Markdown

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.

Summary

Types

Continue with default conversion behavior

Replace default output with custom markdown

Stop conversion with an error

Preserve original HTML (don't convert to markdown)

Skip this element entirely (don't output anything)

t()

Result of a visitor callback.

Types

continue()

@type continue() :: :continue

Continue with default conversion behavior

custom()

@type custom() :: %{type: :custom, value: String.t()}

Replace default output with custom markdown

error()

@type error() :: %{type: :error, value: String.t()}

Stop conversion with an error

preserve_html()

@type preserve_html() :: :preserve_html

Preserve original HTML (don't convert to markdown)

skip()

@type skip() :: :skip

Skip this element entirely (don't output anything)

t()

@type t() :: term()

Result of a visitor callback.