ExPdfInspector.MarkdownOptions (ExPdfInspector v0.1.0)

Copy Markdown View Source

Configures how PDF content is converted to Markdown.

The :fidelity profile preserves more document details. The :compact profile produces simpler output:

%ExPdfInspector.MarkdownOptions{profile: :compact}

Detection and inclusion options can be changed individually. For example:

%ExPdfInspector.MarkdownOptions{
  detect_headers: false,
  include_images: true,
  include_page_numbers: true
}

Summary

Types

The formatting profile applied to the generated Markdown.

t()

Options used to generate Markdown.

Types

profile()

@type profile() :: :fidelity | :compact

The formatting profile applied to the generated Markdown.

t()

@type t() :: %ExPdfInspector.MarkdownOptions{
  base_font_size: float() | nil,
  detect_bold: boolean(),
  detect_code: boolean(),
  detect_headers: boolean(),
  detect_italic: boolean(),
  detect_lists: boolean(),
  detect_underline: boolean(),
  fix_hyphenation: boolean(),
  format_urls: boolean(),
  include_images: boolean(),
  include_links: boolean(),
  include_page_numbers: boolean(),
  profile: profile(),
  remove_page_numbers: boolean(),
  strip_headers_footers: boolean()
}

Options used to generate Markdown.