Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.9...v2.14.10

What's Changed

• chore(deps): bump actions/download-artifact from 5 to 7 by @dependabot[bot] in https://github.com/Goldziher/html-to-markdown/pull/155
• chore(deps): bump actions/upload-artifact from 5 to 6 by @dependabot[bot] in https://github.com/Goldziher/html-to-markdown/pull/154

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.7...v2.14.9

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.7...v2.14.8

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.6...v2.14.7

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.5...v2.14.6

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.4...v2.14.5

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.3...v2.14.4

What's Changed

• chore(deps): bump actions/download-artifact from 6 to 7 by @dependabot[bot] in https://github.com/Goldziher/html-to-markdown/pull/151
• chore(deps): bump actions/upload-artifact from 5 to 6 by @dependabot[bot] in https://github.com/Goldziher/html-to-markdown/pull/152

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.2...v2.14.3

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.14.1...v2.14.2

[2.14.1] - 2025-12-12

Fixed

• Issue #147: Word wrap now works correctly in list items when using the -w/--wrap flag. List items with long text are properly wrapped while preserving list structure and indentation for both ordered and unordered lists.
• Issue #146: strip_tags and preserve_tags options now correctly prevent <meta> and <title> tags from being extracted into YAML frontmatter when extract_metadata is enabled.
• Issue #145: strip_newlines=true no longer causes excessive whitespace around block elements. Structural whitespace is now properly normalized while still removing newlines within paragraph content.

Release v2.14.0

🎉 Complete Metadata Extraction Release

This release completes the metadata extraction feature across all language bindings with comprehensive documentation, critical bug fixes, and 100% language compliance.

✨ New Features

CLI Metadata Extraction

• New --with-metadata flag with JSON output support
• Six extraction flags: --extract-document, --extract-headers, --extract-links, --extract-images, --extract-structured-data
• JSON output format: {"markdown": "...", "metadata": {...}}
• Feature enabled by default in CLI builds

Go FFI Binding

• Complete ConvertWithMetadata() function with typed structs
• 12 Go struct types with JSON tags for type-safe metadata access
• JSON unmarshaling from FFI layer
• 18 comprehensive tests covering all metadata types

Java FFI Binding

• Complete convertWithMetadata() method with Java records
• 11 Java record types using Panama FFM for FFI integration
• Proper enum types for link/image/text direction (no string-based parsing)
• Jackson JSON deserialization with error handling
• 33 comprehensive tests including negative test cases

C# FFI Binding

• Complete ConvertWithMetadata() method with C# records
• 11 C# record types using P/Invoke for FFI integration
• System.Text.Json deserialization with proper error handling
• 23 comprehensive tests covering all metadata types

FFI Core API

• New html_to_markdown_convert_with_metadata() C function
• JSON serialization for language-agnostic metadata transfer
• Proper memory management and error handling
• 17 comprehensive tests including memory safety tests

📚 Documentation Improvements

Documentation Consolidation

• Deleted standalone METADATA.md files (TypeScript: 480 lines, Ruby: 228 lines)
• Enhanced Python, PHP, TypeScript, Ruby, Go, Java, and C# READMEs with comprehensive metadata sections
• Root README now includes CLI metadata examples and links to all binding documentation
• Each binding README is now self-contained with full metadata documentation
• Added 3,500+ lines of comprehensive metadata documentation

Type Definitions Enhancement

• Go: Complete struct types with JSON tags and godoc comments
• Java: Proper enum types (LinkType, ImageType, TextDirection) instead of strings
• C#: Complete record types with XML documentation
• Python: Fixed max_structured_data_size default (100KB → 1MB)
• TypeScript: Verified dimensions field type for compatibility

Docstrings Enhancement

• Rust core: Improved function and module documentation
• Python: Enhanced PyO3 docstrings with examples and type hints
• Ruby: Added YARD tags for better documentation generation
• PHP: Enhanced docblocks with detailed parameter descriptions

🐛 Critical Bug Fixes

FFI Memory Safety

• Fixed critical memory safety bug where error paths could leave dangling metadata pointers
• Both markdown and metadata pointers now set to null on any error
• Added comprehensive memory safety tests

CLI Flag Implementation

• Fixed --extract-document flag not being mapped to MetadataConfig
• Flag now correctly controls document metadata extraction
• Added 9 new CLI tests for metadata flags

Java Type Safety

• Fixed metadata loss from missing dimensions field in ImageMetadata (was causing 50% data loss)
• Changed linkType, imageType, textDirection from String to proper enum types
• Fixed exception swallowing in getLastError() - now logs errors and returns descriptive messages

Python Default Values

• Fixed incorrect max_structured_data_size default (was 100KB, corrected to 1MB)
• Now uses DEFAULT_MAX_STRUCTURED_DATA_SIZE constant from Rust core

Constants Extraction

• Eliminated DRY violations by extracting hardcoded magic numbers
• Added DEFAULT_MAX_STRUCTURED_DATA_SIZE: usize = 1_000_000 constant in Rust core
• Reused across FFI, CLI, and Python bindings

📊 Test Coverage & Quality

Comprehensive Testing

• Added 55 new tests across all bindings (71 → 126 total tests, 77% increase)
• FFI: 13 new tests (4 → 17 total)
• CLI: 9 new tests (67 → 76 total)
• Java: 33 new tests (0 → 33 total)
• Go: 18 tests total
• C#: 23 tests total
• 100% pass rate across all 126 tests

Language Compliance

• Achieved 100% compliance across all bindings (up from 50%-100% range)
• All bindings now correctly implement metadata extraction with proper types
• Standardized error handling and JSON parsing patterns

📦 What's Included

This release includes complete metadata extraction support for:

• ✅ Python (PyO3 bindings)
• ✅ TypeScript/Node.js (NAPI-RS bindings)
• ✅ Ruby (Magnus bindings)
• ✅ PHP (ext-php-rs bindings)
• ✅ WebAssembly (wasm-bindgen)
• ✅ Go (CGO FFI wrapper) - NEW
• ✅ Java (Panama FFM wrapper) - NEW
• ✅ C#/.NET (P/Invoke wrapper) - NEW
• ✅ CLI (Rust binary) - NEW

🚀 Upgrade Notes

All metadata extraction features are fully backward compatible. To use the new features:

CLI Users

# Extract all metadata as JSON
html-to-markdown input.html --with-metadata \
  --extract-document --extract-headers --extract-links \
  --extract-images --extract-structured-data

Go Users

import "github.com/Goldziher/html-to-markdown/packages/go/htmltomarkdown"

result, err := htmltomarkdown.ConvertWithMetadata(html)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Markdown: %s\n", result.Markdown)
fmt.Printf("Title: %s\n", result.Metadata.Document.Title)

Java Users

import io.github.goldziher.htmltomarkdown.*;

MetadataExtraction result = HtmlToMarkdown.convertWithMetadata(html);
System.out.println("Markdown: " + result.markdown());
System.out.println("Title: " + result.metadata().document().title());

C# Users

using HtmlToMarkdown;

var result = HtmlToMarkdownConverter.ConvertWithMetadata(html);
Console.WriteLine($"Markdown: {result.Markdown}");
Console.WriteLine($"Title: {result.Metadata.Document.Title}");

🔗 Resources

• Documentation
• Python Binding README
• TypeScript Binding README
• Go Binding README
• Java Binding README
• C# Binding README
• Changelog

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.13.0...v2.14.0

Highlights

• New convert_with_metadata API across all bindings (Python, TypeScript/Node, Ruby, PHP, WASM) returning Markdown + extracted metadata in one call.
• Rich metadata: document fields (title/description/keywords/author/lang), header hierarchy with IDs/depth, classified links with rel/attrs, image metadata with type detection & dimensions, structured data extraction (JSON-LD/Microdata/RDFa).
• Enabled metadata feature by default for TypeScript & Ruby bindings; synchronized versions across the workspace to 2.13.0.

Language specifics

• Python: 50+ integration tests, strict TypedDict stubs, mypy validation.
• TypeScript: 14 vitest tests, hasMetadataSupport() runtime detection, expanded docs.
• Ruby: RSpec + RBS coverage, wrapper for convert_with_metadata.
• PHP: Value objects for metadata, 20+ PHPUnit specs, PHPStan max.
• WASM: Metadata extraction with serde_wasm_bindgen serialization & config getters/setters.

Fixes

• Ruby RBS fixes for convert_with_metadata wrapper and redundant ? types.
• TypeScript npm packages now ship metadata feature by default.
• WASM clippy fixes (Default impl, unwrap_or_default, struct init).

Fixed

• Escape literal | characters inside table cells while leaving pipes inside <code> and <pre> untouched to avoid rendering backslashes in code spans/blocks (fixes #140).
• Handle nested tables without double-escaping pipes and add regression coverage for table cells containing code spans/blocks and nested tables.
• Preserve link-only list items when word wrapping is enabled so nested link lists are not merged or reflowed (fixes #143); added regression fixtures for the reported table-of-contents sample.

Changed

• Updated dependency locks/manifests to align with the 2.12.1 release.
• Downgraded Java Maven compiler/source plugins back to 3.x to keep CI builds compatible with Maven 3 runners.

Added

• WebAssembly bundler target now supports Cloudflare Workers, Wrangler, and modern bundlers that provide WebAssembly.Module instead of WebAssembly.Instance.
• Three new WASM usage examples demonstrating different deployment targets:
  • examples/wasm-node: Node.js example using dist-node target
  • examples/wasm-rollup: Browser example using dist-web target with Rollup
  • examples/wasm-cloudflare: Cloudflare Workers example using bundler target with Wrangler

Changed

• WASM bundler entry point now detects and handles WebAssembly.Module instances, building the proper import namespace for wasm-bindgen glue functions.

What's Changed

• Harden Node/WASM bundles to emit fully typed doc comments (no stray any) so the options parameter and inline image attributes stay aligned with WasmConversionOptions.
• Add a Rollup + browser example under examples/wasm-rollup and document it in the WASM README to guide bundler integrations.
• Sync every package manifest to 2.11.4 via task sync-versions.

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.11.2...v2.11.3

Bug Fixes

• CI: Fix aarch64-unknown-linux-gnu CLI binary builds by switching from cross-rs to native cross-compilation to avoid glibc version mismatch

This release fixes the publish workflow failures that prevented v2.11.0 from completing successfully.

Fixed

• Normalize whitespace inside link labels (collapse newlines and extra spaces) so anchors with messy HTML do not emit multi-line [] text.
• Flatten block children inside <a> (e.g., headings/paragraphs nested in anchors) into a single Markdown link instead of duplicating content; regression tests added for the reported Arabic product card case.

Changed

• Synced all workspace/package versions to 2.10.1 via task sync-versions.

Fixed

• UTF-8 safety (Fix #127): guard whitespace trimming against mid-codepoint truncation to eliminate multilingual panics; add fixture + regression test.
• Image conversion (Fix #128): <img> elements with width/height now render as Markdown images instead of raw HTML; regression test for data URIs with dimensions.
• Whitespace: preserve Markdown double-space line breaks while trimming stray trailing spaces; keeps HN fixture and newline-style tests passing across bindings.
• PHP CI: pin composer platform to PHP 8.2 and align symfony/string (7.4.0) for CI PHP 8.2 runners.

Tests

• cargo test -p html-to-markdown-rs --test issue_127_regressions -- --nocapture
• cargo test -p html-to-markdown-rs --test issue_128_regressions -- --nocapture
• cargo test -p html-to-markdown-rs --test issue_121_regressions -- --nocapture
• cargo test -p html-to-markdown-cli --test cli_test -- --nocapture
• task lint

Highlights

• Fix issue #121 regressions: SPA shell and Hacker News samples now render full Markdown output (new fixtures/tests).
• Repair malformed inline/block HTML via html5ever fallback to avoid empty output on broken pages.
• Improve link label recovery (avoid empty anchors unless truly empty) and render layout tables as lists when headers/captions are absent (e.g., HN front page).
• Bump multi-language packages to 2.9.1 via sync_versions.

Changelog

All notable changes to html-to-markdown will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[2.9.0] - 2025-11-20

Added

• Elixir bindings – New html_to_markdown Hex package built with Rustler, exposing the Rust core converter to Elixir with configurable options plus convert/2 and convert!/2.
• WASM runtime verification – Added a Wasmtime-backed e2e suite (e2e/wasm-wasmtime) plus task wasm:test:wasmtime to compile the html-to-markdown-wasm artefact for wasm32-unknown-unknown and execute it inside Wasmtime. CI now runs these tests to ensure the WASM package works outside the browser runtime.

Changed

• Astral tl parser – The HTML parser dependency now points to the actively maintained astral-tl fork (still imported as tl) so comment parsing stays up to date with upstream fixes.
• NuGet Package ID – C# bindings now publish under Goldziher.HtmlToMarkdown to avoid clashing with an existing community package.
• Wasmtime CI Coverage – The Wasmtime e2e job now runs on Linux x64, Linux arm64, macOS, and Windows runners so every GitHub-hosted architecture executes the WASM tests.

Fixed

• PHP PIE source bundle – Release packaging strips the Wasmtime e2e workspace from the staged Cargo.toml, fixing the “failed to load manifest” error in the publish workflow.
• Horizontal rule rendering – <p>…</p><hr> now emits a blank line before --- while preserving blockquote spacing so the rule is never misinterpreted as a setext heading.
• Empty HTML comments – Zero-width <!----> comment nodes are normalized before parsing, so comment placeholders no longer cause the following content to disappear.

[2.8.3] - 2025-11-15

Changed

• Deterministic uv installs – Every uv sync invocation in CI and the Taskfile now runs with --no-install-workspace, ensuring Python dependencies are resolved without mutating editable installs before the subsequent build/test steps run.

Fixed

• NuGet Publishing – Release automation now uses GitHub’s trusted publisher flow via NuGet/login@v1 (OIDC → short-lived API key) before pushing artifacts, removing the dependency on long-lived secrets.
• Hex Publishing – The release workflow invokes mix hex.publish --yes from packages/elixir, with ex_doc bundled as a dev dependency so documentation generation works during release.

[2.8.2] - 2025-11-15

Changed

• Unified Version Sync – scripts/sync_versions.py now updates Elixir @version declarations, the C# .csproj, and the Java pom.xml (alongside every npm/pyproject/Gemfile manifest). task sync-versions bumps the entire multi-language stack to 2.8.2 in one shot.
• CI / Release Toolchains – GitHub Actions now installs Elixir dependencies ahead of Credo and runs on Elixir 1.19 + OTP 28.1, matching the README prerequisites and preventing per-job regex recompilation warnings.
• Taskfile Coverage – Added elixir:update plus full java:{install,update,test,lint} tasks so task setup, task update, task test, and task lint cover every published runtime (Go, C#, Elixir, Java) just like the CI workflows.

[2.8.1] - 2025-11-15

Fixed

• Release Pipeline – Bumped all package manifests to v2.8.1 so the publish workflow can push fresh artifacts after the v2.8.0 smoke-test fixes (PyPI, npm, and RubyGems refuse re-uploads of the same version).

[2.8.0] - 2025-11-15

Added

• Java, C#, and Go Bindings (First Release) – First public release of official Java (JNA), C# (.NET), and Go (CGO) language bindings. All three are integrated into the unified task bench:bindings harness and ship with comprehensive performance data in their READMEs. C# leads at ~1.4k ops/sec (≈171 MB/s), Go at ~1.3k ops/sec (≈165 MB/s), and Java at ~1.0k ops/sec (≈126 MB/s) on the 129 KB Wikipedia lists fixture.

Changed

• BREAKING: Preprocessing Disabled by Default – HTML preprocessing is now disabled by default in the library API to prevent silent content loss. Previously, <nav>, <form>, and related elements (along with all their children) were dropped by default, causing important content inside these tags to be lost. Users who want preprocessing must now explicitly enable it via PreprocessingOptions { enabled: true, ... }. The CLI behavior is unchanged (preprocessing has always been opt-in with --preprocess).
• Rust Toolchain Settings – All crates (including the Ruby binding) now inherit edition = "2024" and rust-version = "1.85" from the workspace to keep toolchain configuration centralized.
• GitHub Actions Workflow DRY – Created 17 reusable composite actions (8 build actions + 9 smoke test actions) to eliminate ~267 lines of duplication between CI and publish workflows.
• Toolchain Management – Migrated to official GitHub Actions parameters for Ruby Bundler 2.7.2 and PHP Composer 2.9.1, removing manual installation scripts.

Fixed

• Windows PHP Extension Build – Replaced php-windows-builder orchestration with direct cargo build matching ext-php-rs's proven approach, resolving LLVM 19 MMX header incompatibilities and Zend symbol linking errors.
• Linux PHP Build – Added php-config path capture and parameter passing to build-php-linux action, fixing "php-config executable not found" errors.
• Ruby Linux Build – Set LD_LIBRARY_PATH on Linux builds to match magnus best practices, preventing potential "strings.h not found" errors.
• golangci-lint CI – Split golangci-lint pre-commit hook into separate invocations for packages/go and examples/go-smoke modules, fixing "directory prefix does not contain main module" errors by running each check from within its Go module directory.
• Windows Go CGO Smoke Test – Documented MSVC/MinGW toolchain incompatibility and skip Windows Go smoke test with informative message, as Go CGO uses MinGW which cannot link against MSVC-compiled Rust FFI libraries.
• Go Code Quality – Removed redundant newline in examples/go-smoke/main.go fmt.Println call (detected by newly-working golangci-lint).

[2.7.2] - 2025-11-12

Fixed

• Node/WASM Binding Regression – HTML preprocessing no longer drops <html>, <head>, or <body> wrappers when their classes resemble navigation chrome, so large Wikipedia fixtures once again emit full markdown (restoring the Vitest length/table expectations for Node bindings and keeping WASM conversions consistent).
• Cloudflare WASM Initialization – Bundler builds of html-to-markdown-wasm now expose initWasm()/wasmReady so edge runtimes that instantiate WebAssembly modules asynchronously (Cloudflare Workers, Vite dev servers, etc.) can await initialization before calling convert(), eliminating the __wbindgen_start runtime error.
• Footer Retention (Fix #120) – The Rust preprocessor keeps plain <footer> content unless the element carries explicit navigation hints (role/class/id). Python and Rust conversions once again preserve footer copy while still stripping true navigation footers such as .site-footer menus.
• Release Smoke Coverage – The publish workflow now downloads the built artifacts (Node, WASM, Python wheels, Ruby gems, PHP zips) and reruns the README smoke installs across Linux/macOS/Windows before any packages are uploaded, ensuring we're testing the exact bits we ship.

[2.7.1] - 2025-11-12

Added

• Language-Specific Benchmarks – Every binding README (Node, WASM, Python, Ruby, PHP, TypeScript) now publishes the latest task bench:bindings throughput numbers so runtime documentation stays aligned with the shared fixtures.
• Examples/Smoke Suite – Added examples/{node,wasm,python,ruby,php,rust}-smoke plus an overview README to exercise both the published artifacts and local builds before a release.

Changed

• Docs Accuracy – Node/WASM READMEs now clearly reference the real npm packages (html-to-markdown-node, html-to-markdown-wasm) and provide correct import samples.
• TypeScript README – Highlights that the CLI wrapper inherits the native Node benchmarks.
• Repository Hygiene – .gitignore now drops .venv/, vendor directories, and nested node_modules/ so smoke tests and language-specific toolchains don’t dirty the tree.
• Ruby Build Metadata – extconf.rb uses a relative path for the embedded Cargo crate and the crate’s Cargo.toml now declares explicit edition, rust-version, and dependency pins, allowing gem install outside the workspace.
• Version Sync Script – scripts/sync_versions.py updates every html-to-markdown-rs dependency pin (workspace root plus downstream crates) to keep cross-language releases in lockstep.

Fixed

• Smoke Test Coverage – Verified Node, WASM, Python, Ruby (local gem), PHP (Composer path repo), and Rust installs; documented gaps where external registries still need to publish html-to-markdown/extension or html-to-markdown 2.7.1 before release.

[2.7.0] - 2025-11-12

Added

• Zero-Copy Inline Images – Node/N-API and WASM bindings now expose convertInlineImagesBuffer / convertBytesWithInlineImages, letting benchmark harnesses feed Buffer/Uint8Array data directly without creating intermediate JS strings.

Changed

• Rust Core Preprocessing – HTML normalization (self-closing fixes, malformed < escaping, script/style stripping) now happens in a single streaming pass that hands owned buffers straight to tl::parse_owned, cutting multiple allocations from every conversion.
• Benchmark Harness + Docs – Re-ran the cross-language runtime suite after the Rust core optimizations and refreshed the README tables, keeping the published throughput numbers (Node/Python/Rust/WASM/PHP) in sync with tools/runtime-bench/results/latest.json.
• Version Alignment – Bumped every package (Rust crates, npm packages, PyPI distribution, Ruby gem, PHP extension, WASM bundle) to 2.7.0 via task sync-versions.

Fixed

• Ruby Benchmark Output – The Ruby benchmark driver now emits JSON without relying on json native extensions, preventing libruby incompatibility errors during task bench:bindings.
• Nested <strong> Normalization (Fix #111) – The Rust converter now tracks when bold markup is already active, so nested <b>/<strong> combinations (including <mark>, <summary>, <legend>) no longer generate **** artifacts (<b>bo<b>ld</b>er</b> correctly becomes **bolder**). The CommonMark harness documents the four spec examples that expect stacked markers and skips them accordingly.
• Heading Whitespace (Fix #118) – ATX/Setext headings swallow layout-only newlines and indentation inside <h1>…<h6> so pretty-printed HTML like <h2>Heading\n Text</h2> renders as a single Markdown heading line.
• Inline Whitespace Preservation – Reworked the inline text pipeline so removing zero-width inline elements (e.g., <input>, <script>, empty <b>) no longer collapses surrounding spaces; fixtures like test_chomp, test_form_with_inputs_inline_mode, and checkbox/task-list rendering now match their expected double-space gaps.
• DOCTYPE Handling (Fix #119) – <!DOCTYPE …> declarations are stripped during preprocessing so they never leak as stray PUBLIC… text in the output, even when metadata extraction is enabled.

[2.6.6] - 2025-11-10

Changed

• Ruby Gem Packaging – Moved the html-to-markdown-rb crate under packages/ruby/ext/html-to-markdown-rb/native and pointed extconf.rb at that path so every published gem now contains the Cargo sources it needs to compile on install.
• Documentation Consistency – Updated the root, crate, and package READMEs to drop references to the unrelated html-to-markdown npm package and to consistently list our supported targets (Node, WASM, Python, Ruby, PHP, CLI).
• Dependency Refresh – Ran task update to upgrade Rust crates, npm packages, Bundler gems, Python requirements, and Composer dependencies across the monorepo.

Fixed

• Rust Clippy Lints – Addressed clippy::unnecessary-map-or in the converter and hOCR table builder by using .is_none_or, keeping inline-image filtering and column pruning logic clear while allowing cargo clippy -D warnings to pass.
• PIE Source Packaging – scripts/package_php_pie_source.sh now copies packages/ruby/.../native into the temporary workspace so the Ruby crate exists when PIE builds the PHP extension.

[2.6.3] - 2025-11-07

Fixed

• Release Pipeline - Fixed missing is_tag output in publish workflow that caused all publishing jobs to be skipped
• Node.js Package Dependencies - Added missing optionalDependencies to html-to-markdown-node package.json to properly link platform-specific binaries
• Version Management - Created centralized version sync script (scripts/sync_versions.py) to maintain consistency across all package manifests (Rust, Node.js, Python, Ruby, WASM)
• Cargo Workspace - Aligned html-to-markdown-rb crate version (was 2.5.7) with workspace version

Changed

• Added task sync-versions command to Taskfile for easy version synchronization across the monorepo

[2.6.2] - 2025-11-07

Fixed

• Table Rowspan Support - Fixed tables with rowspan cells to correctly duplicate cell content across spanned rows instead of showing empty cells (fixes #116)
• Node.js Platform Package Publishing - Fixed workflow to correctly move packed .tgz files to npm directory for publishing
• Deprecation Warnings - Updated CLI tests to use CARGO_BIN_EXE env var instead of deprecated cargo_bin method
• Deprecation Warnings - Replaced deprecated criterion::black_box with std::hint::black_box in benchmarks
• Clippy Warnings - Fixed field assignment warnings by using struct initialization with defaults

[2.6.1] - 2025-11-07

Fixed

• Node.js Platform Packages - Fixed publishing of platform-specific npm packages. The workflow now correctly packs npm directories into .tgz files before publishing, ensuring all platform bindings (linux-x64-gnu, darwin-arm64, win32-x64-msvc, etc.) are published to npm.
• WASM Package Publishing - Added proper WASM package publishing workflow to ensure html-to-markdown-wasm is published to npm registry.

[2.6.0] - 2025-11-07

Added

• PHP Extension Support - Official PHP extension (goldziher/html-to-markdown) providing native HTML to Markdown conversion for PHP 8.2+
  • Built with ext-php-rs for high-performance Rust-backed conversion
  • Supports both Thread-Safe (TS) and Non-Thread-Safe (NTS) builds
  • Available for Windows (x86, x64), Linux, and macOS
  • Distributed via PIE (PHP Installer for Extensions) source bundles
  • Prebuilt Windows binaries for PHP 8.2, 8.3, and 8.4
  • Comprehensive test suite with PHPUnit

Changed

• Refactored PHP build variable names from HTM2MD_* to HTMLTOMARKDOWN_* for improved clarity in Makefile.frag and config.m4
• Bumped all package versions to 2.6.0 across Rust crates, npm packages, PyPI wheels, Ruby gem, and PHP extension

[2.5.7] - 2025-11-03

Added

• Publish Windows PHP extension binaries alongside the PIE source bundle during the release pipeline, enabling one-click installs on every platform.
• Build and archive the CLI binary for Linux (gnu & musl), macOS arm64, and Windows x86_64, plus ship prebuilt WASM bundles (dist/dist-node/dist-web) so every runtime gets first-class artifacts.

Changed

• Renamed the PHP extension package to goldziher/html-to-markdown, moved the Composer metadata to the repository root, and refreshed the documentation/badges for every language target.
• Bumped every package (Rust crates, npm packages, PyPI wheels, Ruby gem, PHP extension) to version 2.5.7.
• Restored the Node.js N-API build matrix so macOS, Windows, and Linux binaries ship automatically with each npm release.

Fixed

• Preserve ordered list numbering and indentation when list items render headings or HTML tables, so mixed block content stays under the correct bullet (fixes #107).

[2.5.6] - 2025-10-30

Changed

• The Ruby gem now packages its own README at the gem root, so RubyGems renders the fully formatted documentation (benchmarks, configuration, CLI notes) without broken links.
• Documentation links: the Ruby README now surfaces GitHub resources (issues, changelog, live demo) alongside feature highlights.
• Bumped every package (Rust crates, npm, PyPI, Ruby gem) to version 2.5.6.

[2.5.5] - 2025-10-30

Changed

• Synced documentation: the root README now links to every language guide, and the Ruby README highlights GitHub resources alongside feature docs.
• Gem packaging now reads the README directly for the RubyGems long description while keeping Rubocop happy on all Ruby sources.
• Bumped every package (Rust crates, npm, PyPI, Ruby gem) to version 2.5.5.

[2.5.4] - 2025-10-30

Changed

• Polished the Ruby gem messaging and README with performance highlights, configuration examples, and CLI guidance to match other language docs.
• Bumped every package (Rust crates, npm, PyPI, Ruby gem) to version 2.5.4.

[2.5.3] - 2025-10-30

Changed

• Publish Ruby gems as precompiled artifacts for Linux (x86_64), macOS (arm64 & x86_64), and Windows (x64) via a matrix GitHub Action, ensuring the CLI executable matches the target platform.
• Split the release workflow into prepare/build/publish stages so dry runs build artifacts without pushing, and trusted publishing now uploads every generated .gem.
• Hardened the gem preparation script to clear stale CLI binaries before copying in the platform-specific build output.
• Re-enabled the cross-language release workflow so crates.io, PyPI wheels/sdist, and both npm packages ship alongside the Ruby release.

[2.5.2] - 2025-10-29

• Fix Ruby gem packaging to embed standalone Cargo manifest (no workspace inheritance) so installs compile out of tree successfully.
• Bump versions across Rust, Node, Python, and Ruby bindings.

[2.5.1] - 2025-10-28

Added

• Magnus-based Ruby gem (html-to-markdown-rb) with CLI proxy and comprehensive specs.

Changed

• CI now includes Ruby coverage across macOS, Linux, and Windows, installing the appropriate toolchains (MSYS2 on Windows) for Magnus builds.
• Release workflow prepares the Ruby gem via trusted publishing alongside existing crates/npm packages.

Fixed

• Bundler version pinned to 2.5.12 to support Ruby 3.2 CI environments.

[2.5.0] - 2025-10-24

Added

• New preserve_tags option - Preserve specific HTML tags in their original HTML form instead of converting them to Markdown. This is useful for complex elements like tables that may not convert well to Markdown. Fixes issue #95.
  • Accepts a list of tag names (e.g., ["table", "form"])
  • Preserves all attributes and nested content as HTML
  • Works independently of strip_tags - can use both options together
  • Available in all bindings: Rust, Python, Node.js, and WASM
  • Comprehensive test coverage in Rust, Python (pytest), and TypeScript (vitest)

Changed

• HTML preprocessing is now enabled by default - The PreprocessingOptions.enabled default changed from False to True to ensure robust handling of malformed HTML. Users who want minimal preprocessing can explicitly set enabled=False.

Fixed

• Task list checkbox support - Fixed sanitizer removing <input type="checkbox"> elements when remove_forms is enabled (default). Checkboxes are now preserved during preprocessing to enable proper task list conversion (- [x] / - [ ]).
  • Added input tag to allowed tags in all sanitization presets (minimal, standard, aggressive)
  • Preserved type and checked attributes on input elements
  • Fixed pre-existing bug where task list checkboxes were silently removed
• Data URI support for inline images - Fixed sanitizer stripping data: URLs from image src attributes. Base64-encoded inline images (data URIs) are now preserved during preprocessing.
  • Added data to allowed URL schemes in all sanitization presets
  • Fixes convert_with_inline_images functionality for base64-encoded images
• CDATA section handling - Fixed test expectation for CDATA sections. CDATA sections are now correctly preserved as-is during HTML parsing instead of being partially stripped.
• hOCR word spacing - Fixed missing whitespace between <span class="ocrx_word"> elements in hOCR documents. Words now have proper spaces between them.
  • Modified OcrxWord converter to insert space before each word if output doesn't end with whitespace or markdown formatting characters
  • Ensures proper word separation in OCR-generated documents without breaking markdown formatting (e.g., *text*, [alt](url), `code`)
• hOCR detection with preprocessing - Fixed hOCR documents not being detected when HTML preprocessing is enabled (new default). The sanitizer now preserves:
  • class attributes on all elements (required for detecting hOCR element types)
  • <meta> tags with name and content attributes (required for hOCR metadata detection)
  • <head> tags (container for meta tags)
• hOCR metadata extraction after sanitization - Fixed metadata extraction failing when preprocessing strips the <head> container element. The extractor now finds orphaned meta tags anywhere in the document, not just inside <head> elements.
• preserve_tags functionality with preprocessing - Fixed preserve_tags not working when HTML preprocessing is enabled (the new default). The sanitizer now:
  • Accepts the preserve_tags list and allows those tags through sanitization
  • Preserves common HTML attributes (id, class, style, title, etc.) on preserved tags
  • Prevents remove_forms from stripping form tags when they're in the preserve list
  • Ensures tags and attributes survive preprocessing so they can be output as HTML
• SVG support for inline image extraction - Fixed SVG elements being stripped by the sanitizer, breaking inline image capture. All sanitization presets now allow:
  • SVG elements: svg, circle, rect, path, line, polyline, polygon, ellipse, g
  • SVG attributes: width, height, viewBox, cx, cy, r, x, y, d, fill, stroke
  • Enables convert_with_inline_images to capture inline SVG elements
• Robust handling of malformed angle brackets in HTML - Fixed parser failures when bare < or > characters appear in HTML text content (e.g., 1<2, mathematical comparisons). The converter now:
  • Automatically escapes malformed angle brackets that aren't part of valid HTML tags
  • Works correctly with preprocessing both enabled and disabled
  • Handles edge cases like 1<2, 1 < 2 < 3, and angle brackets at tag boundaries
  • Fixes issue #94 where content following malformed angle brackets was lost
• Added comprehensive test coverage for malformed angle bracket handling in both Rust and Python test suites
• Fixed WASM build configuration to use correct getrandom backend for wasm32-unknown-unknown targets

[2.4.1] - 2025-10-22

Fixed

• Ensure npm publishes include the generated Node bindings and platform binaries by running the N-API build during CI.
• Configure WebAssembly builds with the wasm_js backend and strip wasm-pack .gitignore files so published packages ship the compiled .wasm artifacts.

[2.4.0] - 2025-10-22

Changed

• Updated Rust workspace dependencies (including pyo3) to their latest compatible releases and refreshed lockfiles.
• Normalized hOCR conversion spacing by collapsing stray triple newlines, ensuring generated Markdown matches regression fixtures.

Fixed

• Corrected the WASM crate to depend on getrandom's wasm_js feature, restoring WebAssembly builds.
• Expanded the Node package files list so published tarballs now include compiled .node artifacts, CommonJS shims, and typings.

[2.3.4] - 2025-10-12

Changed

• Incremented all distribution metadata and CLI version checks to 2.3.4 following the previous release tag conflict.
• Regenerated package metadata artifacts for the new patch release.

[2.3.3] - 2025-10-12

Added

• Python API now exports inline image helpers (InlineImage, InlineImageWarning, and InlineImageConfig) alongside convert_with_inline_images, with dedicated regression tests.
• Node and WASM bindings include inline image extraction examples and TypeScript definitions, validated by Vitest coverage.

Changed

• Bumped all package metadata (Python, Rust, Node, WASM, CLI) to version 2.3.3 for a synchronized release.

Fixed

• CLI --version test updated to assert the new release number.

[2.2.0] - 2025-10-11

Added

• hocr_spatial_tables option on ConversionOptions (Rust, Python, CLI) with --no-hocr-spatial-tables flag to disable spatial table reconstruction when desired.
• New hOCR regression fixtures for complex tables and code blocks to guard against formatting regressions.

Changed

• Improved hOCR conversion heuristics to distinguish between dense paragraph layouts and true tables, yielding cleaner Markdown for scientific data.
• hOCR code-block detection now preserves fenced formatting, restoring context headings when present.

Fixed

• CLI --version output and package metadata now report version 2.2.0 consistently.

[2.1.1] - 2025-10-11

Fixed

• Improve hOCR table reconstruction when tables are represented as paragraphs, ensuring Markdown tables are emitted for Tesseract outputs without explicit ocr_table markers.

[2.1.0] - 2025-10-11

Added

• Inline image extraction - New convert_with_inline_images() function to extract embedded images during conversion
  • Supports data URI images (data:image/*)
  • Supports inline SVG elements
  • Configurable via InlineImageConfig with options for:
    • Maximum decoded size limits
    • Custom filename prefixes
    • SVG capture control
    • Optional dimension inference for raster images
  • Returns HtmlExtraction with markdown, extracted images, and warnings
  • Available through both Rust and Python APIs

Changed

• Simplified API - Removed ParsingOptions class in favor of direct encoding parameter on ConversionOptions
• Automatic hOCR table extraction - hOCR tables are now extracted automatically without requiring configuration
  • Removed hocr_extract_tables option (always enabled for hOCR content)
  • Removed hocr_table_column_threshold option (uses built-in heuristics)
  • Removed hocr_table_row_threshold_ratio option (uses built-in heuristics)
• Updated pre-commit hook versions (commitlint v9.23.0, pyproject-fmt v2.10.0, ruff v0.14.0)

Fixed

• hOCR metadata now uses YAML frontmatter instead of HTML comments for cleaner markdown output
• hOCR code organization - Restructured spatial table reconstruction into dedicated hocr/spatial.rs module
• Conservative table detection - hOCR spatial table reconstruction now only applies to explicit ocr_table elements, preventing false positives
• Windows CLI binary detection - now correctly searches for .exe extension on Windows
• CLI binary bundling in Python wheels - binary now included in package for all platforms
• hOCR extractor Rust doctest - added missing import statement
• 928 Python test expectations updated for CommonMark-compliant v2 defaults
• Python 3.14-dev → Python 3.14 stable in CI workflows
• Reorganized wheel preparation script to scripts/ directory
• Removed duplicate markdown documentation files (BENCHMARKS.md, PERFORMANCE.md, BENCHMARK_RESULTS.md, COMMONMARK_COMPLIANCE.md, REFACTORING_SUMMARY.md)

2.0.0 - 2025-10-03

🚀 Major Rewrite: Rust Backend

Version 2.0.0 represents a complete rewrite of html-to-markdown with a high-performance Rust backend, delivering 10-30x performance improvements while maintaining full backward compatibility through a v1 compatibility layer.

⚠️ Breaking Changes

CommonMark-Compliant Defaults

V2 adopts CommonMark-compliant defaults for better interoperability:

Option	V1 Default	V2 Default	Reason
list_indent_width	4	2	CommonMark standard
bullets	"-"	"*+-"	Cycling bullets for nested lists
escape_asterisks	true	false	Minimal escaping
escape_underscores	true	false	Minimal escaping
escape_misc	true	false	Minimal escaping
newline_style	"backslash"	"spaces"	CommonMark two-space line breaks
code_block_style	"backticks"	"indented"	CommonMark 4-space indent
heading_style	"underlined"	"atx"	CommonMark # headings
preprocessing.enabled	false	false	No change (opt-in)

Migration: If you relied on v1 defaults, explicitly set options to match v1 behavior.

Removed CLI Flags

The following v1 CLI flags are not supported in v2. The Python CLI proxy will raise helpful error messages when these flags are used:

Removed Flag	Reason	Migration
--strip	Feature removed in v2	Remove flag (feature no longer available)
--convert	Feature removed in v2	Remove flag (feature no longer available)

Note on Redundant Flags: The following v1 flags are redundant in v2 (they match the defaults) but are silently accepted for backward compatibility:

• --no-escape-asterisks, --no-escape-underscores, --no-escape-misc (v2 defaults to minimal escaping)
• --no-wrap (v2 defaults to no wrapping)
• --no-autolinks (Rust CLI defaults to no autolinks)
• --no-extract-metadata (Rust CLI defaults to no metadata extraction)

These flags can be safely removed from your commands, or you can leave them for compatibility.

Note: The Rust CLI only supports positive flags (e.g., --escape-asterisks, --autolinks, --wrap). Negative flags (--no-*) are only supported through the Python CLI proxy for v1 compatibility.

CommonMark-Compliant List Formatting

• Tight lists no longer have blank lines before nested sublists - This follows the CommonMark specification for list formatting
• Previous behavior (v1): * Item 1\n\n + Nested\n
• New behavior (v2): * Item 1\n + Nested\n
• Why: CommonMark specifies that tight lists (lists without blank lines between items) should not have blank lines before nested sublists
• Impact: Generated markdown will render identically in CommonMark-compliant renderers but may look different in source form
• Migration: If you need the old behavior for specific platforms, you can post-process the output or use loose lists (with blank lines between items)

Added

Core Rust Implementation

• Complete Rust rewrite of HTML-to-Markdown conversion engine using scraper and html5ever
• Native Rust CLI with improved argument parsing and validation
• PyO3 Python bindings for seamless Rust/Python integration
• Automatic hOCR table extraction with built-in heuristics for OCR documents

New V2 API

• Clean, modern API with dataclass-based configuration
• convert(html, options, preprocessing) - primary API entry point
• ConversionOptions - comprehensive conversion settings (now includes encoding)
• PreprocessingOptions - HTML cleaning configuration
• Legacy parsing options removed in favour of explicit encoding on ConversionOptions
• Improved type safety with full type stubs (.pyi files)

V1 Compatibility Layer

• 100% backward compatible v1 API through compatibility layer
• convert_to_markdown() function with all v1 kwargs
• Smart translation of v1 options to v2 dataclasses
• CLI argument translation for v1 flags
• Clear error messages for unsupported v1 features

Testing & Quality

• 77 new tests for v1 compatibility (32 bindings + 26 CLI + 19 integration)
• Comprehensive integration tests with actual CLI execution
• Wheel testing workflow for cross-platform validation
• Python 3.10, 3.12, 3.14-dev test matrix
• Dual coverage reporting (Python + Rust)

CI/CD Improvements

• Shared build-wheels action for consistent wheel building
• Test-wheels workflow with full test suite on built wheels
• Rust coverage with cargo-llvm-cov
• Python coverage in LCOV format
• Automated wheel building for Python 3.10-3.13

Changed

Performance

• 60-80x faster than v1 for most conversion operations (144-208 MB/s throughput)
• Memory-efficient processing with Rust's zero-cost abstractions
• Optimized table handling with rowspan/colspan tracking
• Faster list processing with unified helpers

Architecture

• Removed Python implementation (converters.py, processing.py, preprocessor.py)
• Migrated to Rust-based conversion engine
• Simplified Python layer to thin wrapper around Rust bindings
• CLI now proxies to native Rust binary with argument translation

API Design

• More explicit configuration with separate option classes
• Better separation of concerns (conversion/preprocessing/parsing)
• Clearer parameter naming and organization
• Improved error messages and exception handling

Removed v1 Features

The following v1 features were removed in v2:

• code_language_callback - Removed (use code_language option for default language)
• strip option - Removed (use preprocessing options instead)
• convert option - Removed (all supported tags are converted by default)
• convert_to_markdown_stream() - Removed (html5ever does not support streaming parsing)

Not Yet Implemented

• custom_converters - Planned for future release with Rust and Python callback support

Migration Guide

For Most Users (No Changes Needed)

If you're using the v1 API, your code will continue to work:

from html_to_markdown import convert_to_markdown

# This still works in v2!
markdown = convert_to_markdown(html, heading_style="atx")

To Use New V2 API (Recommended)

from html_to_markdown import convert, ConversionOptions

options = ConversionOptions(heading_style="atx")
markdown = convert(html, options)

CLI Changes

V1 CLI flags are automatically translated to v2:

# V1 style (still works)
html-to-markdown --preprocess-html --escape-asterisks input.html

# V2 style (recommended)
html-to-markdown --preprocess input.html  # escaping is default

Performance Benchmarks

Real-world performance improvements over v1 (Apple M4):

Document Type	Size	V2 Latency	V2 Throughput	Speedup vs V1 (2.5 MB/s)
Lists (Timeline)	129KB	0.62ms	208 MB/s	83x
Tables (Countries)	360KB	2.02ms	178 MB/s	71x
Mixed (Python wiki)	656KB	4.56ms	144 MB/s	58x

V2's Rust engine delivers 60-80x higher throughput than V1's Python/BeautifulSoup implementation across real-world documents.

Technical Details

Rust Crates Structure

crates/
├── html-to-markdown/       # Core conversion library
├── html-to-markdown-py/    # Python bindings (PyO3)
└── html-to-markdown-cli/   # Native CLI binary

Python Package Structure

html_to_markdown/
├── api.py                  # V2 API
├── options.py              # V2 configuration dataclasses
├── v1_compat.py           # V1 compatibility layer
├── cli_proxy.py           # CLI argument translation
├── _rust.pyi              # Rust binding type stubs
└── __init__.py            # Public API exports

Breaking Changes Summary

None if using v1 compatibility layer. If migrating to v2 API:

1. Import changes: convert_to_markdown → convert
2. Configuration: Kwargs → Dataclasses (ConversionOptions)
3. Defaults changed: See CommonMark-compliant defaults table above
4. Removed features: See Removed v1 Features section above

Complete V1 vs V2 Comparison

API Differences

Aspect	V1	V2
Primary API	convert_to_markdown(**kwargs)	convert(html, options, preprocessing, parsing)
Configuration	Keyword arguments	Dataclasses (ConversionOptions, etc.)
Type Safety	Basic type hints	Full .pyi stubs + generics
Compatibility Layer	N/A	convert_to_markdown() with v1 kwargs

Performance Differences

Document Type	V1 Throughput	V2 Throughput	Speedup
Lists (Timeline)	2.5 MB/s	208 MB/s	83x
Tables (Countries)	2.5 MB/s	178 MB/s	71x
Mixed (Python wiki)	2.5 MB/s	144 MB/s	58x
Average	2.5 MB/s	177 MB/s	71x

Implementation Differences

Component	V1	V2
HTML Parser	BeautifulSoup4 / lxml	html5ever (Rust)
Sanitizer	Custom Python	html5ever DOM filtering
Conversion	Pure Python (~3,850 lines)	Pure Rust (~4,800 lines)
Bindings	N/A	PyO3
CLI	Python wrapper	Native Rust binary
Dependencies	bs4, lxml, soupsieve	None (statically linked)

Output Differences (Default Settings)

HTML	V1 Output	V2 Output
<ul><li>Item</li></ul>	* Item (4 spaces)	- Item (2 spaces)
<h1>Title</h1>	Title\n=====	# Title
Text*with*stars	Text\*with\*stars	Text*with*stars
<br>	Two trailing spaces	Backslash \
<pre>code</pre>	```\ncode\n```	Indented 4 spaces

These differences reflect v2's alignment with CommonMark specification.

Removed Python Implementation

• Python implementation of HTML conversion
• html_to_markdown/converters.py (1220 lines)
• html_to_markdown/processing.py (1195 lines)
• html_to_markdown/preprocessor.py (404 lines)
• html_to_markdown/whitespace.py (293 lines)
• html_to_markdown/utils.py (37 lines)
• Several test files migrated to Rust or marked as .skip

Total: ~3,850 lines of Python code removed, replaced by ~4,800 lines of Rust

Notes

• Platform Support: Wheels built for Linux, macOS, Windows on x86_64
• Python Version: Requires Python 3.10+
• ABI Compatibility: Uses abi3 for Python 3.10+ wheel reuse
• Rust Version: Built with stable Rust (tested on 1.75+)

---

[1.x] - Previous Versions

For changes in v1.x releases, see git history before the v2 rewrite.

[2.8.3] - 2025-11-16

Changed

• Deterministic uv installs – All automation calls to uv sync now use --no-install-workspace, keeping editable installs untouched until explicit build/test steps run.

Fixed

• NuGet publishing – Release workflow now relies on trusted publishing with NuGet/login@v1 (OIDC → short-lived API key) before pushing packages, so no long-lived secrets are needed.
• Hex publishing – Runs mix hex.publish --yes from packages/elixir and ships ex_doc as a dev dependency so documentation generation succeeds on Hex.pm builds.
• Repeatable releases – RubyGems/Hex/npm/PyPI jobs detect existing versions and skip re-publishing during reruns, while Maven signing is forced through gpg2.

[2.8.2] - 2025-11-15

Changed

• Unified Version Sync – scripts/sync_versions.py now keeps every manifest (Elixir, C#, Java, npm, PyPI, Ruby) in lockstep whenever we run task sync-versions.
• CI / Release Toolchains – GitHub Actions installs Elixir dependencies ahead of Credo and runs on Elixir 1.19 + OTP 28.1.
• Taskfile Coverage – Added elixir:update plus full java:{install,update,test,lint} helpers so task setup/update/test/lint cover all runtimes (Go, C#, Elixir, Java).

Pipeline Improvements

• Hex publishing now uses erlangpack/github-action@v3 with HEX_TOKEN and publishes straight from packages/elixir.
• NuGet packages enforce NUGET_API_KEY secrets and push automatically.
• Maven releases run via WasiqB/maven-publish-action@v1 on Temurin JDK 22 (setup-java@v5).
• PHP PIE source bundles include the Elixir Rustler binding so verification succeeds.

Fixed

• Release Pipeline – Bumped all package manifests to v2.8.1 so the publish workflow can push fresh artifacts after the v2.8.0 smoke-test fixes (PyPI, npm, and RubyGems refuse re-uploads of the same version).

Added

• Java, C#, and Go Bindings (First Release) – First public release of official Java (JNA), C# (.NET), and Go (CGO) language bindings. All three are integrated into the unified task bench:bindings harness and ship with comprehensive performance data in their READMEs. C# leads at ~1.4k ops/sec (≈171 MB/s), Go at ~1.3k ops/sec (≈165 MB/s), and Java at ~1.0k ops/sec (≈126 MB/s) on the 129 KB Wikipedia lists fixture.

Changed

• BREAKING: Preprocessing Disabled by Default – HTML preprocessing is now disabled by default in the library API to prevent silent content loss. Previously, <nav>, <form>, and related elements (along with all their children) were dropped by default, causing important content inside these tags to be lost. Users who want preprocessing must now explicitly enable it via PreprocessingOptions { enabled: true, ... }. The CLI behavior is unchanged (preprocessing has always been opt-in with --preprocess).
• Rust Toolchain Settings – All crates (including the Ruby binding) now inherit edition = "2024" and rust-version = "1.85" from the workspace to keep toolchain configuration centralized.
• GitHub Actions Workflow DRY – Created 17 reusable composite actions (8 build actions + 9 smoke test actions) to eliminate ~267 lines of duplication between CI and publish workflows.
• Toolchain Management – Migrated to official GitHub Actions parameters for Ruby Bundler 2.7.2 and PHP Composer 2.9.1, removing manual installation scripts.

Fixed

• Windows PHP Extension Build – Replaced php-windows-builder orchestration with direct cargo build matching ext-php-rs's proven approach, resolving LLVM 19 MMX header incompatibilities and Zend symbol linking errors.
• Linux PHP Build – Added php-config path capture and parameter passing to build-php-linux action, fixing "php-config executable not found" errors.
• Ruby Linux Build – Set LD_LIBRARY_PATH on Linux builds to match magnus best practices, preventing potential "strings.h not found" errors.
• golangci-lint CI – Split golangci-lint pre-commit hook into separate invocations for packages/go and examples/go-smoke modules, fixing "directory prefix does not contain main module" errors by running each check from within its Go module directory.
• Windows Go CGO Smoke Test – Documented MSVC/MinGW toolchain incompatibility and skip Windows Go smoke test with informative message, as Go CGO uses MinGW which cannot link against MSVC-compiled Rust FFI libraries.
• Go Code Quality – Removed redundant newline in examples/go-smoke/main.go fmt.Println call (detected by newly-working golangci-lint).

Fixed

• Node/WASM Binding Regression – HTML preprocessing no longer drops <html>, <head>, or <body> wrappers when their classes resemble navigation chrome, so large Wikipedia fixtures once again emit full markdown (restoring the Vitest length/table expectations for Node bindings and keeping WASM conversions consistent).
• Cloudflare WASM Initialization – Bundler builds of html-to-markdown-wasm now expose initWasm()/wasmReady so edge runtimes that instantiate WebAssembly modules asynchronously (Cloudflare Workers, Vite dev servers, etc.) can await initialization before calling convert(), eliminating the __wbindgen_start runtime error.
• Footer Retention (Fix #120) – The Rust preprocessor keeps plain <footer> content unless the element carries explicit navigation hints (role/class/id). Python and Rust conversions once again preserve footer copy while still stripping true navigation footers such as .site-footer menus.
• Release Smoke Coverage – The publish workflow now downloads the built artifacts (Node, WASM, Python wheels, Ruby gems, PHP zips) and reruns the README smoke installs across Linux/macOS/Windows before any packages are uploaded, ensuring we're testing the exact bits we ship.

Full changelog: https://github.com/Goldziher/html-to-markdown/blob/main/CHANGELOG.md#272---2025-11-12

Added

• Language-specific READMEs now publish the latest benchmark tables for Node, WASM, Python, Ruby, PHP, and TypeScript.
• Added smoke-test apps under examples/ to install every binding from npm/PyPI/RubyGems/Composer/crates.io and from the local workspace before tagging a release.

Changed

• Node and WASM READMEs call out the correct npm package names and import usage.
• TypeScript documentation now explains that the CLI wrapper inherits the native Node benchmarks.
• .gitignore filters nested node_modules/, .venv/, and vendor/ directories so example installs don't dirty the tree.
• Ruby build metadata points extconf.rb at the embedded Cargo crate via a relative path, and the crate manifest declares explicit edition, rust-version, and dependency pins.
• scripts/sync_versions.py also bumps every html-to-markdown-rs dependency pin to keep downstream crates in sync with the workspace version.

Fixed

• Smoke tests now exercise Node, WASM, Python, Ruby, PHP, and Rust installs (npm/Composer/PyPI/crates.io plus local builds) so we can reproduce registry issues locally before cutting a release.

• Added zero-copy inline-image APIs for Node (N-API) and WASM bindings so benchmark drivers can feed Buffer/Uint8Array payloads directly without re-encoding through JS strings.
  • Streamlined Rust preprocessing into a single pass (self-closing normalization, malformed < escaping, script/style stripping), which reduces allocations before tl::parse_owned.
  • Refreshed the cross-language runtime harness/results and aligned every manifest to 2.7.0 via task sync-versions.
  • Fixed Ruby benchmark JSON emission to avoid optional native extensions that were failing in task bench:bindings.
  • Hardened inline formatting:
    • Nested <strong>/<b> blocks now respect existing bold state (bolder is stable), with CommonMark deviations documented (#111).
    • Pretty-printed headings collapse internal line breaks so Heading\n Text stays on one ATX line (#118).
    • Generic inline whitespace handling preserves intentional gaps when zero-width elements (<input>, <script>, empty <b>) disappear.
  • Sanitized parsing edge cases:
    • <!DOCTYPE …> declarations are stripped during preprocessing so they never leak as stray text (#119).
    • Task-list checkboxes, script/style stripping, and other inline fixtures all retain the expected spacing.

What's Changed

• chore(deps): bump actions/download-artifact from 5 to 6 by @dependabot[bot] in https://github.com/Goldziher/html-to-markdown/pull/117

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.6.5...v2.6.6

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.6.4...v2.6.5

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.6.3...v2.6.4

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v2.6.2...v2.6.3

Fixed

• Table Rowspan Support - Fixed tables with rowspan cells to correctly duplicate cell content across spanned rows instead of showing empty cells (fixes #116)
• Node.js Platform Package Publishing - Fixed workflow to correctly move packed .tgz files to npm directory for publishing
• Deprecation Warnings - Updated CLI tests to use CARGO_BIN_EXE env var instead of deprecated cargo_bin method
• Deprecation Warnings - Replaced deprecated criterion::black_box with std::hint::black_box in benchmarks
• Clippy Warnings - Fixed field assignment warnings by using struct initialization with defaults

Fixed

• Node.js Platform Packages - Fixed publishing of platform-specific npm packages. The workflow now correctly packs npm directories into .tgz files before publishing, ensuring all platform bindings (linux-x64-gnu, darwin-arm64, win32-x64-msvc, etc.) are published to npm.
• WASM Package Publishing - Added proper WASM package publishing workflow to ensure html-to-markdown-wasm is published to npm registry.

Release v2.6.0 - PHP Extension Support

This release adds official PHP extension support alongside existing Rust, Python, Node.js, Ruby, and WASM bindings.

Major Features

• PHP Extension for PHP 8.2+ with PIE distribution
• Prebuilt Windows binaries for PHP 8.2, 8.3, and 8.4
• Full cross-platform support (Windows, Linux, macOS)

What's Changed

• Added PHP extension (goldziher/html-to-markdown) providing native HTML to Markdown conversion
• Built with ext-php-rs for high-performance Rust-backed conversion
• Refactored PHP build variable names for improved clarity
• Bumped all package versions to 2.6.0

Published Packages

• ✅ Python: https://pypi.org/project/html-to-markdown/2.6.0/
• ✅ Rust: https://crates.io/crates/html-to-markdown-rs/2.6.0
• ✅ Node.js: https://www.npmjs.com/package/html-to-markdown/v/2.6.0
• ✅ Ruby: https://rubygems.org/gems/html-to-markdown/versions/2.6.0
• ✅ PHP: Available via PIE (source bundle below)

See CHANGELOG.md for complete details.

Highlights

• Version bump to 2.5.6 across Rust, Python, Ruby, npm (node + wasm), and Homebrew distributions.
• Ruby gem now ships its README at the gem root so RubyGems renders the full Markdown docs (benchmarks, configuration, CLI guidance) correctly.
• Root README links point directly to each language guide’s GitHub README for consistent navigation.

Changelog

See CHANGELOG.md#256---2025-10-30 for details.

Install

# Rust CLI
cargo install html-to-markdown-cli --version 2.5.6

# Python
pip install html-to-markdown==2.5.6

# Node.js / Bun
npm install html-to-markdown-node@2.5.6

# WebAssembly bundle
npm install html-to-markdown-wasm@2.5.6

# Ruby
gem install html-to-markdown -v 2.5.6

# Homebrew
brew tap goldziher/tap
brew install html-to-markdown

Assets

Prebuilt binaries and binding artifacts for every supported platform are attached below. Pick the archive matching your operating system and CPU architecture if you prefer manual downloads.

Highlights

• Version bump to 2.5.5 across every binding (Rust crates, npm packages, PyPI wheels/sdist, Ruby gems, Homebrew taps).
• Ruby gem now sources its long description directly from README.md, so the refreshed docs and performance guidance flow through to RubyGems.
• Root README links for every language guide now go straight to the GitHub READMEs, keeping navigation consistent.

Changelog

See CHANGELOG.md#255---2025-10-30 for the complete list of changes.

Install

# Rust CLI
cargo install html-to-markdown-cli --version 2.5.5

# Python
pip install html-to-markdown==2.5.5

# Node.js / Bun
npm install html-to-markdown-node@2.5.5

# WebAssembly bundle
npm install html-to-markdown-wasm@2.5.5

# Ruby
gem install html-to-markdown -v 2.5.5

# Homebrew
brew tap goldziher/tap
brew install html-to-markdown

Assets

Prebuilt binaries and binding artifacts for every supported platform are attached below. Pick the file that matches your operating system/architecture if you prefer manual downloads.

Highlights

• Version bump to 2.5.4 across every binding (Rust crates, npm packages, PyPI wheel/sdist, Ruby gems, Homebrew taps).
• Ruby gem messaging and README got a glow-up: performance benchmarks, option walkthroughs, preprocessing examples, and CLI guidance now match the docs shipped for other languages.

Changelog

See CHANGELOG.md#254---2025-10-30 for the detailed list of changes.

Install

# Rust CLI
cargo install html-to-markdown-cli --version 2.5.4

# Python
pip install html-to-markdown==2.5.4

# Node.js / Bun
npm install html-to-markdown-node@2.5.4

# WebAssembly bundle
npm install html-to-markdown-wasm@2.5.4

# Ruby
gem install html-to-markdown -v 2.5.4

# Homebrew
brew tap goldziher/tap
brew install html-to-markdown

Assets

Prebuilt binaries and binding artifacts for every supported platform are attached below. Pick the file that matches your operating system/architecture if you prefer manual downloads.

Highlights

• Ship html-to-markdown 2.5.3 across every language binding (Rust crates, npm packages, PyPI wheel/sdist, Ruby gems, Homebrew binary).
• Ruby gem now publishes platform-specific native packages for Linux x86_64, macOS arm64/x86_64, and Windows x64 alongside the universal source gem.
• Publishing workflow is split into prepare/build/publish stages with trusted publishing, and the Ruby pipeline now runs on macOS 13+ to avoid stuck runners.
• scripts/prepare_ruby_gem.rb clears stale CLI binaries before packaging so each platform bundle contains the correct executable.

Changelog

Refer to CHANGELOG.md#253---2025-10-30 for the complete list of changes.

Install

# Rust CLI
cargo install html-to-markdown-cli --version 2.5.3

# Python
pip install html-to-markdown==2.5.3

# Node.js / Bun
npm install html-to-markdown-node@2.5.3

# WebAssembly bundle
npm install html-to-markdown-wasm@2.5.3

# Ruby
gem install html-to-markdown -v 2.5.3

# Homebrew
brew tap goldziher/tap
brew install html-to-markdown

Assets

Prebuilt binaries and binding artifacts for every supported platform are attached below. Pick the file that matches your operating system/architecture if you prefer manual downloads.

• Fix Ruby gem packaging to embed standalone Cargo manifest (no workspace inheritance) so installs compile out of tree successfully.
• Bump versions across Rust, Node, Python, and Ruby bindings.

Added

• Magnus-based Ruby gem (html-to-markdown-rb) with CLI proxy and comprehensive specs.

Changed

• CI now includes Ruby coverage across macOS, Linux, and Windows, installing the appropriate toolchains (MSYS2 on Windows) for Magnus builds.
• Release workflow prepares the Ruby gem via trusted publishing alongside existing crates/npm packages.

Fixed

• Bundler version pinned to 2.5.12 to support Ruby 3.2 CI environments.

What's Changed

See the CHANGELOG for full details.

Installation

Node.js / Bun

npm install html-to-markdown-node

Deno / Browsers

npm install html-to-markdown-wasm

Python (PyPI)

pip install html-to-markdown

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Node.js / Bun

npm install html-to-markdown-node

Deno / Browsers

npm install html-to-markdown-wasm

Python (PyPI)

pip install html-to-markdown

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Node.js / Bun

npm install html-to-markdown-node

Deno / Browsers

npm install html-to-markdown-wasm

Python (PyPI)

pip install html-to-markdown

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Node.js / Bun

npm install html-to-markdown-node

Deno / Browsers

npm install html-to-markdown-wasm

Python (PyPI)

pip install html-to-markdown

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Node.js / Bun

npm install html-to-markdown-node

Deno / Browsers

npm install html-to-markdown-wasm

Python (PyPI)

pip install html-to-markdown

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Node.js / Bun

npm install html-to-markdown-node

Deno / Browsers

npm install html-to-markdown-wasm

Python (PyPI)

pip install html-to-markdown

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Node.js / Bun

npm install @html-to-markdown/node

Deno / Browsers

npm install @html-to-markdown/wasm

Python (PyPI)

pip install html-to-markdown

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Direct Download

Download the appropriate binary for your platform below.

Added

• hocr_spatial_tables option on ConversionOptions (Rust, Python, CLI) with --no-hocr-spatial-tables flag to disable spatial table reconstruction when desired.
• New hOCR regression fixtures for complex tables and code blocks to guard against formatting regressions.

Changed

• Improved hOCR conversion heuristics to distinguish between dense paragraph layouts and true tables, yielding cleaner Markdown for scientific data.
• hOCR code-block detection now preserves fenced formatting, restoring context headings when present.

Fixed

• CLI --version output and package metadata now report version 2.2.0 consistently.

What's Changed

See the CHANGELOG for full details.

Installation

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Python (PyPI)

pip install html-to-markdown

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Python (PyPI)

pip install html-to-markdown

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Python (PyPI)

pip install html-to-markdown

Direct Download

Download the appropriate binary for your platform below.

What's Changed

See the CHANGELOG for full details.

Installation

Homebrew

brew tap goldziher/tap
brew install html-to-markdown

Rust/Cargo

cargo install html-to-markdown-cli

Python (PyPI)

pip install html-to-markdown

Direct Download

Download the appropriate binary for your platform below.

What's Changed

• feat: add hocr support by @Goldziher in https://github.com/Goldziher/html-to-markdown/pull/79

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v1.15.0...v1.16.0

What's Changed

• feat: add support for custom navigation classes in HTML preprocessing by @tommyjs007 in https://github.com/Goldziher/html-to-markdown/pull/77

New Contributors

• @tommyjs007 made their first contribution in https://github.com/Goldziher/html-to-markdown/pull/77

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v1.14.1...v1.15.0

What's Changed

• fix: resolve ancestor caching issue causing escaping inside code/pre blocks by @Goldziher in https://github.com/Goldziher/html-to-markdown/pull/78

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v1.14.0...v1.14.1

🚀 New Features

HTML5lib Parser Support

• Added html5lib parser support for enhanced HTML5 compliance and standards conformance
• Parser output normalization ensures consistent results regardless of parser choice (html.parser, lxml, html5lib)
• All parsers now produce identical markdown output with proper whitespace handling

Enhanced Bytes Input Support

• Comprehensive bytes input handling with automatic encoding detection
• Configurable source encoding via --source-encoding CLI parameter and source_encoding API parameter
• Graceful error handling with errors="replace" for encoding issues
• Direct HTTP response support for seamless web scraping workflows

Performance & Compatibility

• Significant performance improvements with recommended lxml parser (up to 10x faster)
• Cross-platform compatibility verified on Ubuntu, Windows, and macOS
• Python 3.10-3.13 support with comprehensive testing across all versions

🔧 Improvements

Parser Recommendations

• lxml parser recommended for optimal performance in production
• Updated documentation with clear parser guidance and performance comparisons
• Optional dependencies properly configured for easy installation

Testing & Quality

• 2258 tests passing across all supported parsers and platforms
• Enhanced test coverage with parser-agnostic test fixtures
• Whitespace normalization tests ensuring consistent output

CLI Enhancements

• Simplified encoding parameters - consolidated to single --source-encoding option
• Better error handling for encoding and parser issues
• Improved documentation with real-world examples

🐛 Fixes

Bytes Input Processing

• Fixed TypeError when passing bytes to convert_to_markdown() (resolves #73)
• Fixed preprocessing pipeline ordering for bytes input
• Fixed CLI file reading with proper binary/text mode handling

Parser-Specific Issues

• Fixed html5lib whitespace handling in strict mode
• Fixed lxml leading whitespace preservation
• Fixed streaming function preprocessing parameter support

Test Infrastructure

• Fixed test mocking issues across different Python versions
• Fixed parameter naming consistency in test suite
• Fixed edge cases in whitespace handling

📚 Documentation

Updated README

• Parser recommendations with performance guidance
• Enhanced API examples showing best practices
• CLI usage examples with real-world scenarios
• Markdownify comparison highlighting key differences

Technical Details

• Comprehensive type hints with strict MyPy compliance
• Detailed error handling documentation
• Performance benchmarks showing parser speed differences

⚡ Breaking Changes

None - This release maintains full backward compatibility while adding new features.

🔗 Dependencies

New Optional Dependencies

• html5lib - For enhanced HTML5 standards compliance
• Install with: pip install html-to-markdown[html5lib]

Recommended Setup

# For best performance (recommended)
pip install html-to-markdown[lxml]

# For maximum standards compliance
pip install html-to-markdown[html5lib]

# For all parser options
pip install html-to-markdown[lxml,html5lib]

🎯 Migration Guide

For Existing Users

• No changes required - all existing code continues to work
• Optional: Consider switching to lxml parser for better performance
• Optional: Update CLI scripts to use --source-encoding instead of separate encoding parameters

For New Users

• Use lxml parser for production applications requiring high performance
• Use html5lib parser for applications requiring strict HTML5 compliance
• Use default html.parser for simple applications with no additional dependencies

---

Full Changelog: https://github.com/Goldziher/html-to-markdown/compare/v1.13.0...v1.14.0

Major Features

1. Parser-agnostic testing system - A comprehensive fixture system that allows tests to run with both lxml and html.parser backends, ensuring compatibility across different parsers and platforms (Linux, Mac, Windows)

Bug Fixes

1. Trailing newline preservation - Fixed issues with preserving trailing newlines for block-like elements, dialog, and MathML blocks
2. Windows CLI Unicode handling - Resolved unicode decoding issues on Windows by reading bytes and decoding with replace error handling
3. Line ending normalization - Fixed cross-platform test issues by normalizing CRLF to LF in subprocess helpers
4. Whitespace restoration - Prevented leading whitespace restoration when strip_newlines=True