HtmlToMarkdown.UrlEscapeStyle (html_to_markdown v3.11.4)

Copy Markdown

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).

Summary

Types

t()

URL encoding strategy for link and image destinations.

Functions

angle()

Wrap destinations that contain spaces or newlines in angle brackets. Default.

percent()

Percent-encode all characters that are not RFC 3986 unreserved or /.

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() :: :angle | :percent

URL encoding strategy for link and image destinations.

Functions

angle()

@spec angle() :: t()

Wrap destinations that contain spaces or newlines in angle brackets. Default.

percent()

@spec percent() :: t()

Percent-encode all characters that are not RFC 3986 unreserved or /.

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.