HtmlToMarkdown (html_to_markdown v3.22.2)

Copy Markdown

High-level API for html_to_markdown

Summary

Functions

Convert HTML to Markdown, Djot, or plain text.

Convert HTML to Markdown, Djot, or plain text.

Convert HTML with an explicit accessible-name policy for this call.

Convert HTML with an explicit accessible-name policy for this call.

Functions

convert(html)

@spec convert(String.t()) ::
  {:ok, HtmlToMarkdown.ConversionResult.t()} | {:error, atom(), String.t()}

Convert HTML to Markdown, Djot, or plain text.

convert(html, options)

@spec convert(String.t(), String.t() | nil) ::
  {:ok, HtmlToMarkdown.ConversionResult.t()} | {:error, atom(), String.t()}

Convert HTML to Markdown, Djot, or plain text.

convert_with_accessible_names(html, use_accessible_names)

@spec convert_with_accessible_names(String.t(), boolean()) ::
  {:ok, HtmlToMarkdown.ConversionResult.t()} | {:error, atom(), String.t()}

Convert HTML with an explicit accessible-name policy for this call.

convert_with_accessible_names(html, use_accessible_names, options)

@spec convert_with_accessible_names(String.t(), boolean(), String.t() | nil) ::
  {:ok, HtmlToMarkdown.ConversionResult.t()} | {:error, atom(), String.t()}

Convert HTML with an explicit accessible-name policy for this call.