HtmlToMarkdown.OutputFormat (html_to_markdown v3.11.4)

Copy Markdown

Output format for conversion.

Specifies the target markup language format for the conversion output.

Summary

Types

t()

Output format for conversion.

Functions

djot()

Djot lightweight markup language.

markdown()

Standard Markdown (CommonMark compatible). Default.

plain()

Plain text output (no markup, visible text only).

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() :: :markdown | :djot | :plain

Output format for conversion.

Functions

djot()

@spec djot() :: t()

Djot lightweight markup language.

markdown()

@spec markdown() :: t()

Standard Markdown (CommonMark compatible). Default.

plain()

@spec plain() :: t()

Plain text output (no markup, visible text only).

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.