HtmlToMarkdown.ConversionOptions (html_to_markdown v3.6.0-rc.16)

Copy Markdown

Main conversion options for HTML to Markdown conversion.

Use [ConversionOptions::builder()] to construct, or [Default::default()] for defaults.

Example

use html_to_markdown_rs::{ConversionOptions, HeadingStyle};

let options = ConversionOptions::builder()
    .heading_style(HeadingStyle::Atx)
    .wrap(true)
    .wrap_width(100)
    .build();

Summary

Types

t()

Main conversion options for HTML to Markdown conversion.

Types

t()

@type t() :: %HtmlToMarkdown.ConversionOptions{
  autolinks: boolean(),
  br_in_tables: boolean(),
  bullets: String.t() | nil,
  capture_svg: boolean(),
  code_block_style: String.t() | nil,
  code_language: String.t() | nil,
  compact_tables: boolean(),
  convert_as_inline: boolean(),
  debug: boolean(),
  default_title: boolean(),
  encoding: String.t() | nil,
  escape_ascii: boolean(),
  escape_asterisks: boolean(),
  escape_misc: boolean(),
  escape_underscores: boolean(),
  exclude_selectors: [String.t()],
  extract_images: boolean(),
  extract_metadata: boolean(),
  heading_style: String.t() | nil,
  highlight_style: String.t() | nil,
  include_document_structure: boolean(),
  infer_dimensions: boolean(),
  keep_inline_images_in: [String.t()],
  link_style: String.t() | nil,
  list_indent_type: String.t() | nil,
  list_indent_width: non_neg_integer(),
  max_depth: non_neg_integer() | nil,
  max_image_size: non_neg_integer(),
  newline_style: String.t() | nil,
  output_format: String.t() | nil,
  preprocessing: map(),
  preserve_tags: [String.t()],
  skip_images: boolean(),
  strip_newlines: boolean(),
  strip_tags: [String.t()],
  strong_em_symbol: String.t() | nil,
  sub_symbol: String.t() | nil,
  sup_symbol: String.t() | nil,
  tier_strategy: String.t() | nil,
  url_escape_style: String.t() | nil,
  visitor: reference() | nil,
  whitespace_mode: String.t() | nil,
  wrap: boolean(),
  wrap_width: non_neg_integer()
}

Main conversion options for HTML to Markdown conversion.