html2text
A Python library and CLI tool that converts HTML into clean, readable Markdown-formatted plain text.
What is html2text?
html2text is a Python library and command-line utility that converts HTML into clean, readable plain text formatted as Markdown. It solves the problem of extracting meaningful text from web pages or HTML snippets while preserving formatting like bold, italics, and links in a Markdown-compatible way. This makes it useful for developers, writers, and anyone needing to transform HTML content into a more portable text format.
Python developers, technical writers, and content creators who need to programmatically convert HTML to Markdown for documentation, data processing, or content migration tasks.
Developers choose html2text for its simplicity, configurability, and dual CLI/library interface, offering a straightforward, dependency-light alternative to more complex HTML parsing tools.
Overview
Convert HTML to Markdown-formatted text.
Use Cases
Best For
- Converting HTML email content to Markdown for documentation
- Extracting readable text from web pages during scraping projects
- Migrating blog posts or articles from HTML to Markdown format
- Preprocessing HTML content for static site generators
- Integrating HTML-to-text conversion into Python automation scripts
- Generating plain-text summaries from HTML snippets
Not Ideal For
- Projects involving JavaScript-rendered HTML content, as html2text only parses static HTML and cannot handle dynamically loaded elements.
- Applications requiring output formats beyond Markdown, such as LaTeX, RTF, or PDF, since it focuses solely on Markdown conversion.
- High-volume batch processing where performance and memory efficiency are critical, due to its lightweight, non-optimized design.
- Systems that must perfectly parse malformed or highly nested HTML without manual intervention, as it may require flags like --escape-all to avoid errors.
Pros & Cons
Pros
Directly converts HTML tags like <strong> to **bold** and <a> to [link](url), as shown in the Python example with Zed's dead baby output.
Offers command-line flags such as --ignore-links and --escape-all, and Python settings like ignore_links for customizable formatting, detailed in the usage section.
Can be used as a CLI tool for quick conversions or imported as a Python library for programmatic integration, demonstrated in the README with both modes.
Available on PyPI with a simple pip install, has minimal dependencies, and focuses on simplicity without heavy external libraries.
Cons
The --escape-all option admits corner case issues, indicating it can struggle with complex or malformed HTML, requiring trade-offs in output readability.
Focuses on core Markdown elements; lacks support for advanced features like tables, nested lists, or modern Markdown extensions, which may limit comprehensive conversions.
Documentation is linked externally and might be incomplete, as the README only provides basic examples, leaving users to explore usage details on their own.
Frequently Asked Questions
Related Projects
browser-use🌐 Make websites accessible for AI agents. Automate tasks online with ease.
crawl4ai🚀🤖 Crawl4AI: Open-source LLM Friendly Web Crawler & Scraper. Don't be shy, join here: https://discord.gg/jP8KfhDhyN
scrapyScrapy, a fast high-level web crawling & scraping framework for Python.
trafilaturaPython & Command-line tool to gather text and metadata on the Web: Crawling, scraping, extraction, output as CSV, JSON, HTML, MD, TXT, XML
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.