Packages
html_to_markdown
3.2.2
3.9.0
3.8.3
3.8.2
3.8.1
3.8.0
3.8.0-rc.2
3.8.0-rc.1
3.7.2
3.7.1
3.7.0
3.6.21
3.6.20
3.6.19
3.6.18
3.6.17
3.6.16
3.6.15
3.6.14
3.6.13
3.6.11
3.6.10
3.6.9
3.6.8
3.6.3
3.6.1
3.6.0
3.6.0-rc.25
3.6.0-rc.23
3.6.0-rc.22
3.6.0-rc.21
3.6.0-rc.20
3.6.0-rc.17
3.6.0-rc.16
3.6.0-rc.14
3.6.0-rc.13
3.6.0-rc.12
3.6.0-rc.11
3.6.0-rc.10
3.6.0-rc.9
3.6.0-rc.7
3.6.0-rc.3
3.6.0-rc.2
3.6.0-rc.1
3.5.7
3.5.5
3.5.3
3.5.2
3.5.1
3.5.0
3.5.0-rc.1
3.4.0
3.4.0-rc.45
3.4.0-rc.44
3.4.0-rc.42
3.4.0-rc.41
3.4.0-rc.40
3.4.0-rc.25
3.4.0-rc.24
3.4.0-rc.23
3.4.0-rc.21
3.4.0-rc.20
3.4.0-rc.18
3.4.0-rc.16
3.4.0-rc.15
3.4.0-rc.14
3.4.0-rc.13
3.4.0-rc.12
3.4.0-rc.11
3.4.0-rc.9
3.4.0-rc.8
3.4.0-rc.2
3.4.0-rc.1
3.3.2
3.2.4
3.2.2
3.2.1
3.2.0
3.1.0
3.0.2
3.0.1
3.0.0
2.30.0
2.29.0
2.28.6
2.28.5
2.28.4
2.28.3
2.28.2
2.28.1
2.28.0
2.27.3
2.27.2
2.27.1
2.27.0
2.26.3
2.26.2
2.26.1
2.25.1
2.25.0
2.24.6
2.24.5
2.24.4
2.24.3
2.24.1
2.23.4
2.23.3
2.23.2
2.23.1
2.23.0
2.22.5
2.22.2
2.22.1
2.22.0
2.21.1
2.20.0
2.19.8
2.19.7
2.19.6
2.19.5
2.19.4
2.19.3
2.19.2
2.19.1
2.19.0
2.18.0
2.16.1
2.16.0
2.15.0
2.14.11
2.14.10
2.14.9
2.14.8
2.14.7
2.14.6
2.14.3
2.14.2
2.14.1
2.14.0
2.13.0
2.12.1
2.12.0
2.11.4
2.11.3
2.11.1
2.10.1
2.9.2
2.9.1
2.9.0
2.8.3
High-performance HTML to Markdown converter
Current section
Files
Jump to
Current section
Files
lib/html_to_markdown.ex
# This file is auto-generated by alef. DO NOT EDIT.
defmodule HtmlToMarkdown do
@moduledoc "High-level API for html_to_markdown."
@doc "Convert HTML to Markdown, returning a [`ConversionResult`] with content, metadata, images,"
@spec convert(String.t()) :: {:ok, String.t() | nil} | {:error, String.t()}
def convert(html) do
HtmlToMarkdown.Native.convert(html, nil)
end
@doc "Convert HTML to Markdown, returning a [`ConversionResult`] with content, metadata, images,"
@spec convert(String.t(), String.t() | nil | nil) ::
{:ok, String.t() | nil} | {:error, String.t()}
def convert(html, options) do
HtmlToMarkdown.Native.convert(html, options)
end
@doc "Create default metadata configuration."
@spec metadataconfig_default() :: String.t() | nil
def metadataconfig_default do
HtmlToMarkdown.Native.metadataconfig_default()
end
@doc "Check if any metadata extraction is enabled."
@spec metadataconfig_any_enabled(map()) :: boolean()
def metadataconfig_any_enabled(obj) do
HtmlToMarkdown.Native.metadataconfig_any_enabled(obj)
end
@doc "Validate that the header level is within valid range (1-6)."
@spec headermetadata_is_valid(map()) :: boolean()
def headermetadata_is_valid(obj) do
HtmlToMarkdown.Native.headermetadata_is_valid(obj)
end
@doc "Classify a link based on href value."
@spec linkmetadata_classify_link(String.t()) :: map()
def linkmetadata_classify_link(href) do
HtmlToMarkdown.Native.linkmetadata_classify_link(href)
end
@doc "Method"
@spec conversionoptions_default() :: String.t() | nil
def conversionoptions_default do
HtmlToMarkdown.Native.conversionoptions_default()
end
@doc "Create a new builder with default values."
@spec conversionoptions_builder() :: reference()
def conversionoptions_builder do
HtmlToMarkdown.Native.conversionoptions_builder()
end
@doc "Set the list of HTML tag names whose content is stripped from output."
@spec conversionoptionsbuilder_strip_tags(map(), [String.t()]) :: reference()
def conversionoptionsbuilder_strip_tags(obj, tags) do
HtmlToMarkdown.Native.conversionoptionsbuilder_strip_tags(obj, tags)
end
@doc "Set the list of HTML tag names that are preserved verbatim in output."
@spec conversionoptionsbuilder_preserve_tags(map(), [String.t()]) :: reference()
def conversionoptionsbuilder_preserve_tags(obj, tags) do
HtmlToMarkdown.Native.conversionoptionsbuilder_preserve_tags(obj, tags)
end
@doc "Set the list of HTML tag names whose `<img>` children are kept inline."
@spec conversionoptionsbuilder_keep_inline_images_in(map(), [String.t()]) :: reference()
def conversionoptionsbuilder_keep_inline_images_in(obj, tags) do
HtmlToMarkdown.Native.conversionoptionsbuilder_keep_inline_images_in(obj, tags)
end
@doc "Set the pre-processing options applied to the HTML before conversion."
@spec conversionoptionsbuilder_preprocessing(map(), String.t() | nil) :: reference()
def conversionoptionsbuilder_preprocessing(obj, preprocessing) do
HtmlToMarkdown.Native.conversionoptionsbuilder_preprocessing(obj, preprocessing)
end
@doc "Build the final [`ConversionOptions`]."
@spec conversionoptionsbuilder_build(map()) :: String.t() | nil
def conversionoptionsbuilder_build(obj) do
HtmlToMarkdown.Native.conversionoptionsbuilder_build(obj)
end
@doc "Method"
@spec preprocessingoptions_default() :: String.t() | nil
def preprocessingoptions_default do
HtmlToMarkdown.Native.preprocessingoptions_default()
end
end