html-to-markdown

Turn messy, real-world HTML into clean Markdown — from the language you already work in.

Feed html-to-markdown the HTML you actually have — unclosed tags, CDATA, custom elements, broken entities, nested tables, mixed encodings — and get back clean CommonMark (or Djot) without losing content. One convert() call does it, and it returns the same result whether you run it from Python, TypeScript, Go, Ruby, Java, or 11 more languages.

You get more than the text: pull page metadata (Open Graph, Twitter, JSON-LD) and structured tables in the same pass, or hook into the conversion to reshape the output. It is fast enough for whole-corpus jobs, and the messy-input handling is automatic — you never choose a parsing strategy or tune anything to get correct output.

⭐ Star this repo to show your support — it helps others discover html-to-markdown.

convert() is the single entry point — it returns a structured result with content, warnings, and optional metadata.

cargo add html-to-markdown-rs

The Rust crate needs Rust 1.99 or newer.

See Rust README for full documentation.

pip install html-to-markdown

See Python README for full documentation.

pnpm add @xberg-io/html-to-markdown

See Node.js README for full documentation.

go get github.com/xberg-io/html-to-markdown/packages/go/v3

See Go README for full documentation.

Available on Maven Central as io.xberg:html-to-markdown. See Java README for the dependency snippet and current version.

dotnet add package XbergIo.HtmlToMarkdown

See C# README for full documentation.

gem install html-to-markdown

See Ruby README for full documentation.

This is a native PHP extension (Rust ext-php-rs), so install it with PIE — not composer require:

pie install xberg-io/html-to-markdown

See PHP README for full documentation.

Add {:html_to_markdown, "~> 3.6"} to your mix.exs dependencies. See Elixir README for full documentation.

install.packages("htmltomarkdown", repos = "https://xberg-io.r-universe.dev")

See R README for full documentation.

dart pub add h2m

See Dart README for full documentation.

Available on Maven Central as io.xberg:html-to-markdown-android. See Kotlin README for the dependency snippet and current version.

Add via Swift Package Manager. See Swift README for full documentation.

See Zig README for installation and usage.

pnpm add @xberg-io/html-to-markdown-wasm

See WebAssembly README for full documentation.

Pre-built .so / .dll / .dylib from GitHub Releases. See FFI crate for full documentation.

cargo install html-to-markdown-cli

# Or install the prebuilt binary via cargo-binstall:
cargo binstall html-to-markdown-cli

brew install xberg-io/tap/html-to-markdown

Windows users can install the same binary through Scoop:

scoop bucket add xberg https://github.com/xberg-io/scoop-bucket
scoop install html-to-markdown

Every install provides the CLI as both html-to-markdown and the short alias h2m.

See CLI usage for full documentation.

Install the html-to-markdown plugin from xberg-io/html-to-markdown. It ships the html-to-markdown agent skills — select your runtime below.

The bundle targets Claude Code, Codex, Cursor, Gemini CLI, Kimi, OpenCode, Factory Droid, Hermes, Pi, Agent Plugins and GitHub Copilot CLI. Read the plugin guide for runtime resources, CLI prerequisites and configuration. MCP-capable adapters expose the product's tools; Hermes uses a local stdio bridge and explicitly selected skills. Pi loads skills and prompt templates and requires the product CLI for executable operations.

Install only the public Agent Skills, without a plugin or MCP registration, using the skills CLI:

npx skills add xberg-io/html-to-markdown --list
npx skills add xberg-io/html-to-markdown

Choose the skills and target agents interactively. Installing instructions does not install the product CLI or configure provider credentials.

/plugin marketplace add xberg-io/html-to-markdown
/plugin install html-to-markdown@html-to-markdown

/plugins add https://github.com/xberg-io/html-to-markdown

Then search for html-to-markdown and select Install Plugin.

Settings → Plugins → Add from URL → https://github.com/xberg-io/html-to-markdown, then select html-to-markdown.

From a checkout of this repository:

gemini extensions install ./plugin

The manifest is inside plugin/. See the Gemini extension reference for local installation and updates.

droid plugin marketplace add https://github.com/xberg-io/html-to-markdown
droid plugin install html-to-markdown@html-to-markdown

copilot plugin marketplace add https://github.com/xberg-io/html-to-markdown
copilot plugin install html-to-markdown@html-to-markdown

From a checkout of this repository:

pi install ./plugin

After the next plugin release, install the same package used by OpenCode:

pi install npm:@xberg-io/opencode-html-to-markdown

Pi loads the bundled skills and prompt templates. Use /html-to-markdown-convert or /html-to-markdown-metadata with the input as arguments. Install the html-to-markdown CLI separately for shell access. This package does not register MCP servers, hooks, or native Pi extensions.

Add the package to opencode.json:

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["@xberg-io/opencode-html-to-markdown"]
}

Full guides, the convert() API for every binding, tier architecture, the metadata and visitor APIs, and performance benchmarks live at docs.html-to-markdown.xberg.io.

• Xberg — the open-source content-intelligence engine: text, tables, and metadata from 101 formats (115 file extensions), with OCR, transcription, and code intelligence. MIT.
• Xberg Pro — a complete self-hosted content-intelligence backend in a single container. Commercial.
• Xberg Enterprise — the distributed, governed content-intelligence platform, scaled on Kubernetes with team governance and support. Commercial.
• crawlberg — web crawling and scraping with HTML→Markdown and headless-Chrome fallback.
• html-to-markdown — fast, lossless HTML→Markdown engine.
• liter-llm — universal LLM API client with native bindings for 14 languages and 165 providers.
• tree-sitter-language-pack — tree-sitter grammars and code-intelligence primitives.
• alef — the polyglot binding generator that produces every per-language binding across the 5 polyglot repos.

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

MIT License — see LICENSE for details.