html-to-markdown 2.30.0-x86_64-linux → 3.0.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee8dd2c455a6a86421af27a2066b1e93f6c460073643222d4ac762eb1f7d0189
-  data.tar.gz: 2d15f7312c9127aef99b419fb60fc4be7d63687dfed2dcccf00be9cb098ee3cb
+  metadata.gz: 07d676f000540af84276c48d2b0e84768e9f4708098cdda3de3d999520e7e716
+  data.tar.gz: 3b7fbe10fc72c7af0965ded5f770e0cf6fec353e39497d029f80d7c77f6c7f24
 SHA512:
-  metadata.gz: 0cb644c37d6bac86198cfc45150b59a7dbda7ffdce7116dd153d045bfd3d182703d9d4f47edf67825d0cd67807c1b09a4d9b527dc3c453291a5bf4c93957ce5b
-  data.tar.gz: ec204e318d2d9f01f34e5801958354d7a1266e750bb12abd72b1c07baf9ea904a49d353bfaf65f6b4a2b30d41a94da835e3755f0b5a426a9677cf88e985ffdbb
+  metadata.gz: 207023e2ce048eb36df739aa1166af50b2086ea8c388016250d838230b8c7dba1b5be208540c9afb93277538a9551183a83370d46aa6f71b750073bb71a8cb91
+  data.tar.gz: 8801822711dc240f82151044a45248bcc3656080ddf3d922ec6391c4371d49ce801227b0c85cfb5a4488827af1474a8e84c650b576272d1ae6f6c97e0d9cc1ad

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    html-to-markdown (2.30.0)
+    html-to-markdown (3.0.0)
       rb_sys (>= 0.9, < 1.0)
 
 GEM
@@ -22,16 +22,13 @@ GEM
       uri (>= 0.13.1)
     ast (2.4.3)
     base64 (0.3.0)
-    bigdecimal (4.0.1)
+    bigdecimal (4.1.0)
     concurrent-ruby (1.3.6)
     connection_pool (3.0.2)
     csv (3.3.5)
     diff-lcs (1.6.2)
     drb (2.2.3)
-    ffi (1.17.4-aarch64-linux-gnu)
     ffi (1.17.4-arm64-darwin)
-    ffi (1.17.4-x64-mingw-ucrt)
-    ffi (1.17.4-x86_64-darwin)
     ffi (1.17.4-x86_64-linux-gnu)
     fileutils (1.8.0)
     i18n (1.14.8)
@@ -129,12 +126,8 @@ GEM
     uri (1.1.1)
 
 PLATFORMS
-  aarch64-linux
   arm64-darwin
-  x64-mingw-ucrt
-  x86_64-darwin
   x86_64-linux
-  x86_64-linux-gnu
 
 DEPENDENCIES
   html-to-markdown!
@@ -150,19 +143,16 @@ CHECKSUMS
   activesupport (8.1.3) sha256=21a5e0dfbd4c3ddd9e1317ec6a4d782fa226e7867dc70b0743acda81a1dca20e
   ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
   base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b
-  bigdecimal (4.0.1) sha256=8b07d3d065a9f921c80ceaea7c9d4ae596697295b584c296fe599dd0ad01c4a7
+  bigdecimal (4.1.0) sha256=6dc07767aa3dc456ccd48e7ae70a07b474e9afd7c5bc576f80bd6da5c8dd6cae
   concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
   connection_pool (3.0.2) sha256=33fff5ba71a12d2aa26cb72b1db8bba2a1a01823559fb01d29eb74c286e62e0a
   csv (3.3.5) sha256=6e5134ac3383ef728b7f02725d9872934f523cb40b961479f69cf3afa6c8e73f
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
   drb (2.2.3) sha256=0b00d6fdb50995fe4a45dea13663493c841112e4068656854646f418fda13373
-  ffi (1.17.4-aarch64-linux-gnu) sha256=b208f06f91ffd8f5e1193da3cae3d2ccfc27fc36fba577baf698d26d91c080df
   ffi (1.17.4-arm64-darwin) sha256=19071aaf1419251b0a46852abf960e77330a3b334d13a4ab51d58b31a937001b
-  ffi (1.17.4-x64-mingw-ucrt) sha256=f6ff9618cfccc494138bddade27aa06c74c6c7bc367a1ea1103d80c2fcb9ed35
-  ffi (1.17.4-x86_64-darwin) sha256=aa70390523cf3235096cf64962b709b4cfbd5c082a2cb2ae714eb0fe2ccda496
   ffi (1.17.4-x86_64-linux-gnu) sha256=9d3db14c2eae074b382fa9c083fe95aec6e0a1451da249eab096c34002bc752d
   fileutils (1.8.0) sha256=8c6b1df54e2540bdb2f39258f08af78853aa70bad52b4d394bbc6424593c6e02
-  html-to-markdown (2.30.0)
+  html-to-markdown (3.0.0)
   i18n (1.14.8) sha256=285778639134865c5e0f6269e0b818256017e8cde89993fdfcbfb64d088824a5
   json (2.19.3) sha256=289b0bb53052a1fa8c34ab33cc750b659ba14a5c45f3fcf4b18762dc67c78646
   language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc

data/README.md

@@ -17,8 +17,8 @@
   <a href="https://central.sonatype.com/artifact/dev.kreuzberg/html-to-markdown">
     <img src="https://img.shields.io/maven-central/v/dev.kreuzberg/html-to-markdown?label=Java&color=007ec6" alt="Java">
   </a>
-  <a href="https://pkg.go.dev/github.com/kreuzberg-dev/html-to-markdown/packages/go/v2/htmltomarkdown">
-    <img src="https://img.shields.io/github/v/tag/kreuzberg-dev/html-to-markdown?label=Go&color=007ec6&filter=v2.29.0" alt="Go">
+  <a href="https://pkg.go.dev/github.com/kreuzberg-dev/html-to-markdown/packages/go/v3/htmltomarkdown">
+    <img src="https://img.shields.io/github/v/tag/kreuzberg-dev/html-to-markdown?label=Go&color=007ec6&filter=v3.0.0" alt="Go">
   </a>
   <a href="https://www.nuget.org/packages/KreuzbergDev.HtmlToMarkdown/">
     <img src="https://img.shields.io/nuget/v/KreuzbergDev.HtmlToMarkdown?label=C%23&color=007ec6" alt="C#">
@@ -87,7 +87,6 @@ Apple M4 • Real Wikipedia documents • `convert()` (Ruby)
 | Mixed (Python wiki) | 656KB | 4.89ms | 134 MB/s |
 
 
-See [Performance Guide](../../examples/performance/) for detailed benchmarks.
 
 
 ## Quick Start
@@ -98,7 +97,8 @@ Basic conversion:
 require 'html_to_markdown'
 
 html = "<h1>Hello</h1><p>This is <strong>fast</strong>!</p>"
-markdown = HtmlToMarkdown.convert(html)
+result = HtmlToMarkdown.convert(html)
+markdown = result[:content]
 ```
 
 
@@ -109,60 +109,50 @@ With conversion options:
 require 'html_to_markdown'
 
 html = "<h1>Hello</h1><p>This is <strong>fast</strong>!</p>"
-markdown = HtmlToMarkdown.convert(html, heading_style: :atx, code_block_style: :fenced)
+result = HtmlToMarkdown.convert(html, heading_style: :atx, code_block_style: :fenced)
+markdown = result[:content]
 ```
 
 
 
 
-
-
 ## API Reference
 
-### Core Functions
-
-
-**`convert(html, options: nil) -> String`**
+### Core Function
 
-Basic HTML-to-Markdown conversion. Fast and simple.
 
-**`convert_with_metadata(html, options: nil, config: nil) -> [String, Hash]`**
+**`convert(html, options: nil, visitor: nil) -> ConversionResult`**
 
-Extract Markdown plus metadata (headers, links, images, structured data) in a single pass. See [Metadata Extraction Guide](../../examples/metadata-extraction/).
+Converts HTML to Markdown. Returns a `ConversionResult` hash with all results in a single call.
 
-**`convert_with_visitor(html, visitor:, options: nil) -> String`**
-
-Customize conversion with visitor callbacks for element interception. See [Visitor Pattern Guide](../../examples/visitor-pattern/).
-
-**`convert_with_inline_images(html, config: nil) -> [String, Array, Array]`**
-
-Extract base64-encoded inline images with metadata.
-
-**`convert_with_tables(html, options: nil, config: nil) -> ConversionWithTables`**
+```ruby
+require 'html_to_markdown'
 
-Extract structured table data (cells, headers, rendered markdown) alongside conversion.
+result = HtmlToMarkdown.convert(html)
+markdown = result[:content]       # Converted Markdown string
+metadata = result[:metadata]      # Metadata (when extract_metadata: true)
+tables   = result[:tables]        # Structured table data (when extract_tables: true)
+document = result[:document]      # Document-level info
+images   = result[:images]        # Extracted images
+warnings = result[:warnings]      # Any conversion warnings
+```
 
 
 
 ### Options
 
 **`ConversionOptions`** – Key configuration fields:
+
 - `heading_style`: Heading format (`"underlined"` | `"atx"` | `"atx_closed"`) — default: `"underlined"`
 - `list_indent_width`: Spaces per indent level — default: `2`
 - `bullets`: Bullet characters cycle — default: `"*+-"`
 - `wrap`: Enable text wrapping — default: `false`
 - `wrap_width`: Wrap at column — default: `80`
 - `code_language`: Default fenced code block language — default: none
-- `extract_metadata`: Embed metadata as YAML frontmatter — default: `false`
+- `extract_metadata`: Enable metadata extraction into `result.metadata` — default: `false`
+- `extract_tables`: Enable structured table extraction into `result.tables` — default: `false`
 - `output_format`: Output markup format (`"markdown"` | `"djot"` | `"plain"`) — default: `"markdown"`
 
-**`MetadataConfig`** – Selective metadata extraction:
-- `extract_headers`: h1-h6 elements — default: `true`
-- `extract_links`: Hyperlinks — default: `true`
-- `extract_images`: Image elements — default: `true`
-- `extract_structured_data`: JSON-LD, Microdata, RDFa — default: `true`
-- `max_structured_data_size`: Size limit in bytes — default: `100KB`
-
 
 ## Djot Output Format
 
@@ -222,16 +212,17 @@ Plain text mode is useful for search indexing, text extraction, and feeding cont
 
 ## Metadata Extraction
 
-The metadata extraction feature enables comprehensive document analysis during conversion. Extract document properties, headers, links, images, and structured data in a single pass.
+The metadata extraction feature enables comprehensive document analysis during conversion. Extract document properties, headers, links, images, and structured data in a single pass — all via the standard `convert()` function.
 
 **Use Cases:**
+
 - **SEO analysis** – Extract title, description, Open Graph tags, Twitter cards
 - **Table of contents generation** – Build structured outlines from heading hierarchy
 - **Content migration** – Document all external links and resources
 - **Accessibility audits** – Check for images without alt text, empty links, invalid heading hierarchy
 - **Link validation** – Classify and validate anchor, internal, external, email, and phone links
 
-**Zero Overhead When Disabled:** Metadata extraction adds negligible overhead and happens during the HTML parsing pass. Disable unused metadata types in `MetadataConfig` to optimize further.
+**Zero Overhead When Disabled:** Metadata extraction adds negligible overhead and happens during the HTML parsing pass. Pass `extract_metadata: true` in `ConversionOptions` to enable it; the result is available at `result.metadata`.
 
 ### Example: Quick Start
 
@@ -240,27 +231,27 @@ The metadata extraction feature enables comprehensive document analysis during c
 require 'html_to_markdown'
 
 html = '<h1>Article</h1><img src="test.jpg" alt="test">'
-markdown, metadata = HtmlToMarkdown.convert_with_metadata(html)
-
-puts metadata[:document][:title]           # Document title
-puts metadata[:headers]                    # All h1-h6 elements
-puts metadata[:links]                      # All hyperlinks
-puts metadata[:images]                     # All images with alt text
-puts metadata[:structured_data]            # JSON-LD, Microdata, RDFa
+result = HtmlToMarkdown.convert(html, extract_metadata: true)
+
+puts result[:content]                             # Converted Markdown
+puts result[:metadata][:document][:title]         # Document title
+puts result[:metadata][:headers]                  # All h1-h6 elements
+puts result[:metadata][:links]                    # All hyperlinks
+puts result[:metadata][:images]                   # All images with alt text
+puts result[:metadata][:structured_data]          # JSON-LD, Microdata, RDFa
 ```
 
 
 
-For detailed examples including SEO extraction, table-of-contents generation, link validation, and accessibility audits, see the [Metadata Extraction Guide](../../examples/metadata-extraction/).
-
 
 
 
 ## Visitor Pattern
 
-The visitor pattern enables custom HTML→Markdown conversion logic by providing callbacks for specific HTML elements during traversal. Use visitors to transform content, filter elements, validate structure, or collect analytics.
+The visitor pattern enables custom HTML→Markdown conversion logic by providing callbacks for specific HTML elements during traversal. Pass a visitor as the third argument to `convert()`.
 
 **Use Cases:**
+
 - **Custom Markdown dialects** – Convert to Obsidian, Notion, or other flavors
 - **Content filtering** – Remove tracking pixels, ads, or unwanted elements
 - **URL rewriting** – Rewrite CDN URLs, add query parameters, validate links
@@ -291,20 +282,16 @@ class MyVisitor
 end
 
 html = '<a href="https://old-cdn.com/file.pdf">Download</a>'
-markdown = HtmlToMarkdown.convert_with_visitor(html, visitor: MyVisitor.new)
+result = HtmlToMarkdown.convert(html, visitor: MyVisitor.new)
+markdown = result[:content]
 ```
 
 
 
-For comprehensive examples including content filtering, link footnotes, accessibility validation, and asynchronous URL validation, see the [Visitor Pattern Guide](../../examples/visitor-pattern/).
-
 
 
 ## Examples
 
-- [Visitor Pattern Guide](../../examples/visitor-pattern/)
-- [Metadata Extraction Guide](../../examples/metadata-extraction/)
-- [Performance Guide](../../examples/performance/)
 
 ## Links
 

data/lib/html_to_markdown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HtmlToMarkdown
-  VERSION = '2.30.0'
+  VERSION = '3.0.0'
 end

data/lib/html_to_markdown.rb

@@ -7,205 +7,24 @@ module HtmlToMarkdown
   autoload :CLI, 'html_to_markdown/cli'
   autoload :CLIProxy, 'html_to_markdown/cli_proxy'
 
-  class Options; end # rubocop:disable Lint/EmptyClass
-
   class << self
     alias native_convert convert
-    alias native_convert_with_inline_images convert_with_inline_images
-    alias native_convert_with_inline_images_handle convert_with_inline_images_handle
-    alias native_options options
-    alias native_convert_with_options convert_with_options
-    alias native_convert_with_metadata convert_with_metadata
-    alias native_convert_with_metadata_handle convert_with_metadata_handle
-    alias native_convert_with_visitor convert_with_visitor
-    alias native_convert_with_tables convert_with_tables
   end
 
   module_function
 
-  def convert(html, options = nil, visitor = nil)
-    if visitor
-      native_convert_with_visitor(html.to_s, options, visitor)
-    else
-      native_convert(html.to_s, options)
-    end
-  end
-
-  def convert_with_options(html, options_handle)
-    native_convert_with_options(html.to_s, options_handle)
-  end
-
-  def convert_with_inline_images(html, options = nil, image_config = nil, _visitor = nil)
-    # NOTE: visitor parameter is accepted for API compatibility but not used in inline images mode
-    # The visitor pattern is only supported in the standard convert() method
-    native_convert_with_inline_images(html.to_s, options, image_config)
-  end
-
-  def convert_with_inline_images_handle(html, options_handle, image_config = nil)
-    native_convert_with_inline_images_handle(html.to_s, options_handle, image_config)
-  end
-
-  def options(options_hash = nil)
-    native_options(options_hash)
-  end
-
-  # Convert HTML to Markdown with comprehensive metadata extraction.
-  #
-  # Performs HTML-to-Markdown conversion while extracting document metadata, headers,
-  # links, images, and structured data in a single pass. Ideal for content analysis,
-  # SEO workflows, and document indexing.
-  #
-  # @param html [String] HTML string to convert. Line endings are normalized (CRLF -> LF).
-  # @param options [ConversionOptions, Hash, nil] Optional conversion configuration.
-  #   When a Hash, keys should match ConversionOptions field names (as symbols or strings).
-  #   Common options:
-  #   - :heading_style [String] "atx", "atx_closed", or "underlined" (default: "underlined")
-  #   - :list_indent_type [String] "spaces" or "tabs" (default: "spaces")
-  #   - :list_indent_width [Integer] Spaces per indent level (default: 4)
-  #   - :wrap [true, false] Enable text wrapping (default: false)
-  #   - :wrap_width [Integer] Wrap at this column width (default: 80)
-  #   See ConversionOptions documentation for complete list.
-  #
-  # @param metadata_config [Hash, nil] Optional metadata extraction configuration.
-  #   Keys should be symbols or strings. Supported keys:
-  #   - :extract_headers [true, false] Extract h1-h6 heading elements (default: true)
-  #   - :extract_links [true, false] Extract hyperlinks with type classification (default: true)
-  #   - :extract_images [true, false] Extract image elements (default: true)
-  #   - :extract_structured_data [true, false] Extract JSON-LD/Microdata/RDFa (default: true)
-  #   - :max_structured_data_size [Integer] Size limit for structured data in bytes (default: 1_000_000)
-  #
-  # @return [Array<String, Hash>] Tuple of [markdown_string, metadata_hash]
-  #   markdown_string: String - The converted Markdown output
-  #
-  #   metadata_hash: Hash with keys:
-  #   - :document [Hash] Document-level metadata:
-  #     - :title [String, nil] From <title> tag
-  #     - :description [String, nil] From <meta name="description">
-  #     - :keywords [Array<String>] From <meta name="keywords">
-  #     - :author [String, nil] From <meta name="author">
-  #     - :language [String, nil] From lang attribute (e.g., "en")
-  #     - :text_direction [String, nil] "ltr", "rtl", or "auto"
-  #     - :canonical_url [String, nil] From <link rel="canonical">
-  #     - :base_href [String, nil] From <base href="">
-  #     - :open_graph [Hash<String, String>] Open Graph properties (og:* meta tags)
-  #     - :twitter_card [Hash<String, String>] Twitter Card properties (twitter:* meta tags)
-  #     - :meta_tags [Hash<String, String>] Other meta tags
-  #
-  #   - :headers [Array<Hash>] Heading elements:
-  #     - :level [Integer] 1-6
-  #     - :text [String] Header text content
-  #     - :id [String, nil] HTML id attribute
-  #     - :depth [Integer] Tree nesting depth
-  #     - :html_offset [Integer] Byte offset in original HTML
-  #
-  #   - :links [Array<Hash>] Hyperlinks:
-  #     - :href [String] Link URL
-  #     - :text [String] Link text content
-  #     - :title [String, nil] Title attribute
-  #     - :link_type [String] "anchor", "internal", "external", "email", "phone", or "other"
-  #     - :rel [Array<String>] Rel attribute values
-  #     - :attributes [Hash<String, String>] Additional HTML attributes
-  #
-  #   - :images [Array<Hash>] Image elements:
-  #     - :src [String] Image source URL or data URI
-  #     - :alt [String, nil] Alt text for accessibility
-  #     - :title [String, nil] Title attribute
-  #     - :dimensions [Array<Integer>, nil] [width, height] if available
-  #     - :image_type [String] "data_uri", "external", "relative", or "inline_svg"
-  #     - :attributes [Hash<String, String>] Additional HTML attributes
-  #
-  #   - :structured_data [Array<Hash>] Structured data blocks:
-  #     - :data_type [String] "json_ld", "microdata", or "rdfa"
-  #     - :raw_json [String] Raw JSON content
-  #     - :schema_type [String, nil] Schema type (e.g., "Article", "Event")
-  #
-  # @raise [StandardError] If conversion fails or invalid configuration
-  #
-  # @example Basic usage
-  #   html = <<~HTML
-  #     <html lang="en">
-  #       <head>
-  #         <title>My Article</title>
-  #         <meta name="description" content="A great read">
-  #       </head>
-  #       <body>
-  #         <h1 id="intro">Introduction</h1>
-  #         <p>Visit <a href="https://example.com">our site</a></p>
-  #         <img src="photo.jpg" alt="Beautiful landscape">
-  #       </body>
-  #     </html>
-  #   HTML
-  #
-  #   markdown, metadata = HtmlToMarkdown.convert_with_metadata(html)
-  #
-  #   puts metadata[:document][:title]  # => "My Article"
-  #   puts metadata[:document][:language]  # => "en"
-  #   puts metadata[:headers].length  # => 1
-  #   puts metadata[:headers][0][:text]  # => "Introduction"
-  #   puts metadata[:links].length  # => 1
-  #   puts metadata[:images].length  # => 1
-  #
-  # @example With selective metadata extraction
-  #   config = {
-  #     extract_headers: true,
-  #     extract_links: true,
-  #     extract_images: false,      # Skip images
-  #     extract_structured_data: false  # Skip structured data
-  #   }
-  #
-  #   markdown, metadata = HtmlToMarkdown.convert_with_metadata(html, nil, config)
-  #   puts metadata[:images].empty?  # => true (not extracted)
-  #
-  # @example With conversion options
-  #   options = {
-  #     heading_style: "atx",     # Use # H1, ## H2 style
-  #     wrap: true,
-  #     wrap_width: 80
-  #   }
-  #
-  #   config = { extract_headers: true }
-  #
-  #   markdown, metadata = HtmlToMarkdown.convert_with_metadata(html, options, config)
-  #   # Markdown uses ATX-style headings and wraps at 80 characters
-  #
-  # @see #convert Simple conversion without metadata
-  # @see #convert_with_inline_images Extract inline images during conversion
-  # @see ConversionOptions Detailed conversion configuration
-  def convert_with_metadata(html, options = nil, metadata_config = nil, _visitor = nil)
-    # NOTE: visitor parameter is accepted for API compatibility but not used in metadata extraction mode
-    # The visitor pattern is only supported in the standard convert() method
-    native_convert_with_metadata(html.to_s, options, metadata_config)
-  end
-
-  def convert_with_metadata_handle(html, options_handle, metadata_config = nil)
-    native_convert_with_metadata_handle(html.to_s, options_handle, metadata_config)
-  end
-
-  # Convert HTML to Markdown with table extraction.
-  #
-  # Performs HTML-to-Markdown conversion while extracting structured table data
-  # (cells, markdown representation, header row flags) in a single pass.
-  #
-  # @param html [String] HTML string to convert.
-  # @param options [Hash, nil] Optional conversion configuration.
-  # @param metadata_config [Hash, nil] Optional metadata extraction configuration.
-  #
-  # @return [Hash] A hash with keys:
-  #   - :content [String] The converted Markdown output
-  #   - :metadata [Hash, nil] Extended metadata (if metadata extraction was configured)
-  #   - :tables [Array<Hash>] Extracted tables, each with:
-  #     - :cells [Array<Array<String>>] Table cells organized as rows x columns
-  #     - :markdown [String] Complete rendered table in Markdown format
-  #     - :is_header_row [Array<Boolean>] Per-row flag indicating header rows
-  #
-  # @raise [StandardError] If conversion fails or invalid configuration
-  #
-  # @example Basic usage
-  #   html = '<table><thead><tr><th>Name</th></tr></thead><tbody><tr><td>Alice</td></tr></tbody></table>'
-  #   result = HtmlToMarkdown.convert_with_tables(html)
-  #   puts result[:tables].length    # => 1
-  #   puts result[:tables][0][:cells] # => [["Name"], ["Alice"]]
-  def convert_with_tables(html, options = nil, metadata_config = nil)
-    native_convert_with_tables(html.to_s, options, metadata_config)
+  # Convert HTML to Markdown, returning a Hash with:
+  #   - :content [String, nil] the converted Markdown output
+  #   - :document [nil] document structure (not yet exposed)
+  #   - :metadata [Hash, nil] extracted HTML metadata
+  #   - :tables [Array<Hash>] extracted tables with :grid and :markdown
+  #   - :images [Array<Hash>] extracted inline images
+  #   - :warnings [Array<Hash>] processing warnings
+  #
+  # @param html [String] HTML string to convert
+  # @param options [Hash, nil] optional conversion options
+  # @return [Hash] conversion result
+  def convert(html, options = nil)
+    native_convert(html.to_s, options)
   end
 end