Current section

Files

Jump to
html_to_markdown lib html_to_markdown heading_style.ex
Raw

lib/html_to_markdown/heading_style.ex

# This file is auto-generated by alef — DO NOT EDIT.
# alef:hash:7a17843699ae58ecdab45276ab8539da058c5ef81065f3b146250c79aa0b8898
# To regenerate: alef generate
# To verify freshness: alef verify --exit-code
# Issues & docs: https://github.com/kreuzberg-dev/alef
defmodule HtmlToMarkdown.HeadingStyle do
@moduledoc """
Heading style options for Markdown output.
Controls how headings (h1-h6) are rendered in the output Markdown.
"""
@typedoc "Heading style options for Markdown output."
@type t :: :underlined | :atx | :atx_closed
@underlined :underlined
@atx :atx
@atx_closed :atx_closed
@doc "Underlined style (=== for h1, --- for h2)."
@spec underlined() :: t()
def underlined, do: @underlined
@doc "ATX style (# for h1, ## for h2, etc.). Default."
@spec atx() :: t()
def atx, do: @atx
@doc "ATX closed style (# title #, with closing hashes)."
@spec atx_closed() :: t()
def atx_closed, do: @atx_closed
end