Current section

Files

Jump to
html_to_markdown lib html_to_markdown annotation_kind.ex
Raw

lib/html_to_markdown/annotation_kind.ex

# This file is auto-generated by alef — DO NOT EDIT.
# alef:hash:ae27fb2270a21feb95d12e56306ee8cb658cb16e6b0de1fb02eef725f0889bb7
# To regenerate: alef generate
# To verify freshness: alef verify --exit-code
defmodule HtmlToMarkdown.AnnotationKind do
@moduledoc """
The type of an inline text annotation.
Uses internally tagged representation (`"annotation_type": "bold"`) for JSON serialization.
"""
@typedoc "The type of an inline text annotation."
@type t :: term()
@typedoc "Bold / strong emphasis."
@type bold :: :bold
@typedoc "Italic / emphasis."
@type italic :: :italic
@typedoc "Underline."
@type underline :: :underline
@typedoc "Strikethrough / deleted text."
@type strikethrough :: :strikethrough
@typedoc "Inline code."
@type code :: :code
@typedoc "Subscript text."
@type subscript :: :subscript
@typedoc "Superscript text."
@type superscript :: :superscript
@typedoc "Highlighted / marked text."
@type highlight :: :highlight
@typedoc "A hyperlink sourced from an `<a href=\"...\">` element."
@type link :: %{type: :link, url: String.t(), title: String.t()}
def link(url, title), do: {:link, %{url: url, title: title}}
end