goldziher/html-to-markdown

Modern PHP API for the html_to_markdown native extension powered by the Rust html-to-markdown engine.

v4.0.0-rc.16 2025-12-22 09:57 UTC

Requires

• php: ^8.2

Requires (Dev)

• php/pie: ^1.0

MIT

• Na'aman Hirschfeld

Extension name: ext-html_to_markdown

Supports Zend Thread Safety (ZTS): ✅

Supports non-Thread Safe mode (NTS): ✅

Supported operating systems: no restrictions

Configure flags:

• --with-cargo-bin=<value> Path to the cargo executable used to build the extension.

README

High-performance HTML to Markdown conversion powered by Rust. Ships as native bindings for Rust, Python, TypeScript/Node.js, Ruby, PHP, Go, Java, C#, Elixir, R, C (FFI), and WebAssembly with identical rendering across all runtimes.

Documentation | Live Demo | API Reference

Highlights

• 150-280 MB/s throughput (10-80x faster than pure Python alternatives)
• 12 language bindings with consistent output across all runtimes
• Metadata extraction — title, headers, links, images, structured data (JSON-LD, Microdata, RDFa)
• Visitor pattern — custom callbacks for content filtering, URL rewriting, domain-specific dialects
• Table extraction — extract structured table data (cells, headers, rendered markdown) during conversion
• Secure by default — built-in HTML sanitization via ammonia

Quick Start

# Rust
cargo add html-to-markdown-rs

# Python
pip install html-to-markdown

# TypeScript / Node.js
npm install @kreuzberg/html-to-markdown-node

# Ruby
gem install html-to-markdown

# CLI
cargo install html-to-markdown-cli
# or
brew install kreuzberg-dev/tap/html-to-markdown

See the Installation Guide for all languages including PHP, Go, Java, C#, Elixir, R, and WASM.

Part of the Kreuzberg Ecosystem

html-to-markdown is developed by kreuzberg.dev and powers the HTML conversion pipeline in Kreuzberg, a document intelligence library for extracting text from PDFs, images, and office documents.

Contributing

Contributions welcome! See CONTRIBUTING.md for setup instructions and guidelines.

License

MIT License — see LICENSE for details.