HtmlToMarkdown.HighlightStyle (html_to_markdown v3.11.4)

Copy Markdown

Highlight rendering style for <mark> elements.

Controls how highlighted text is rendered in Markdown output.

Summary

Types

t()

Highlight rendering style for <mark> elements.

Functions

bold()

Render as bold (text). Uses strong emphasis.

double_equal()

Double equals syntax (==text==). Default. Pandoc-compatible.

html()

Preserve as HTML (==text==). Original HTML tag.

none()

Strip formatting, render as plain text. No markup.

wire_value(atom)

Returns the serde wire value this variant carries on the JSON boundary (see wire_variant_value in alef's naming module) -- distinct from the atom's Elixir spelling.

Types

t()

@type t() :: :double_equal | :html | :bold | :none

Highlight rendering style for <mark> elements.

Functions

bold()

@spec bold() :: t()

Render as bold (text). Uses strong emphasis.

double_equal()

@spec double_equal() :: t()

Double equals syntax (==text==). Default. Pandoc-compatible.

html()

@spec html() :: t()

Preserve as HTML (==text==). Original HTML tag.

none()

@spec none() :: t()

Strip formatting, render as plain text. No markup.

wire_value(atom)

@spec wire_value(t()) :: String.t()

Returns the serde wire value this variant carries on the JSON boundary (see wire_variant_value in alef's naming module) -- distinct from the atom's Elixir spelling.