HtmlToMarkdown.HeadingStyle (html_to_markdown v3.11.4)

Copy Markdown

Heading style options for Markdown output.

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

Summary

Types

t()

Heading style options for Markdown output.

Functions

atx()

ATX style (# for h1, ## for h2, etc.). Default.

atx_closed()

ATX closed style (# title #, with closing hashes).

underlined()

Underlined style (=== for h1, --- for h2).

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() :: :underlined | :atx | :atx_closed

Heading style options for Markdown output.

Functions

atx()

@spec atx() :: t()

ATX style (# for h1, ## for h2, etc.). Default.

atx_closed()

@spec atx_closed() :: t()

ATX closed style (# title #, with closing hashes).

underlined()

@spec underlined() :: t()

Underlined style (=== for h1, --- for h2).

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.