Skip to content
Package47 repository health

html-to-text

Advanced HTML to plain text converter with word wrapping, tables, and customizable selectors

Library npmv10.0.11,762 stars MIT License
npm install html-to-text
View source

Repository health

Pre-computed score based on development activity, maintenance, community, maturity, and trend momentum.How we score it →
Fair
  • Development activity16
  • Maintenance0
  • Community72
  • Maturity60
  • Momentum40

Technical analysis

AI-assessed by reading the actual repository — architecture, code quality, innovation, and documentation.How we score it →
Excellent
  • Architecture85
  • Code quality82
  • Innovation88
  • Learning curve75

html-to-text is a battle-tested Node.js library that parses HTML documents and renders them as clean, readable plain text. It handles the messy realities of real-world markup — inline and block-level tags, tables with colspans and rowspans, links with their hrefs, Unicode content, and word wrapping — so you never have to strip tags with brittle regular expressions again.

Beyond simple tag stripping, it exposes a stylesheet-like selector system that lets you decide exactly how each element is formatted, skipped, or transformed. With over 11 million weekly downloads, it is the de-facto standard for generating plain-text email bodies, previews, search indexes, and text snapshots from HTML.

What You Get

  • A simple convert / htmlToText function plus a compile factory for reusing options across many documents at high throughput
  • A stylesheet-like selector system to format, skip, or customize the rendering of any HTML element
  • Built-in formatters for links, images, tables, ordered and unordered lists, headings, blockquotes, and horizontal rules
  • Configurable word wrapping, long-word splitting, whitespace handling, and entity decoding
  • Dual CommonJS and ES module builds with bundled TypeScript typedefs

Common Use Cases

  • Generating plain-text alternatives for HTML emails so messages render in text-only clients
  • Producing readable previews, excerpts, or notification snippets from stored HTML content
  • Feeding clean text into full-text search indexes or analytics pipelines
  • Creating deterministic text snapshots of rendered HTML for testing

Under The Hood

Architecture

The project is a pnpm-style monorepo whose published html-to-text package sits on top of a shared base package. A call to convert first composes user options with the defaults via options-composer, then parses the HTML string with htmlparser2 into a DOM. Element formatting decisions come from the selectors array, which selderee/parseley compile into an efficient decision tree so each DOM node is matched against selectors in near-constant time rather than being tested one-by-one. Matched nodes are dispatched to formatters (in text-formatters.js, table-printer.js, and the base package’s generic formatters) that push content into a BlockTextBuilder; that builder — together with InlineTextBuilder and whitespace-processor — handles block spacing, inline concatenation, whitespace collapsing, and word wrapping to assemble the final string.

Tech Stack

Written in modern JavaScript (ES2022, ESM-first) targeting Node.js >= 20.19. Runtime dependencies are minimal and focused: htmlparser2 for HTML parsing, dom-serializer for serialization, selderee with @selderee/plugin-htmlparser2 for selector compilation, and deepmerge-ts for options merging. The package ships dual CJS/ESM bundles produced by Rollup; tests run on AVA with c8 for coverage, and linting is handled by ESLint.

Code Quality

The codebase is small, modular, and well-tested. The html-to-text package alone carries roughly two dozen AVA test files spread across general behavior, individual tag handling, and full-document snapshot fixtures. Source files are concise (the core is around 200 lines), documented with JSDoc typedefs, and cleanly separate parsing, selector matching, and text building into distinct modules. Options are validated and merged predictably, and the extensive CHANGELOG documents deprecations across major versions.

API Design The public surface is deliberately tiny — convert, its htmlToText alias, and compile — which makes the common case trivial while the selector and custom-formatter systems provide deep escape hatches for advanced needs. The 22 KB README documents every option, selector, and predefined formatter with runnable examples, and the compile pattern gives a clear, well-signposted path to high performance when processing batches. Naming is consistent and the migration notes between major versions are thorough.

Used by 22 apps in this directory

Every app whose dependencies include html-to-text, nine to a page.

Showing 22 apps
TypeScript 95%Apache 2.0

AionUi

34,417

AI Agents · Productivity

Free, open-source Cowork desktop app that unifies Claude Code, Codex, Gemini CLI, and 20+ AI agents into a single platform with multi-agent teams, 24/7 cron automation, and zero-config built-in agent.

App
Built with
  • TypeScript 95%
Updated 2 weeks agoView details
JavaScript 99%MIT

AnythingLLM

68,474

AI Assistants · Automation · Developer Tools

The all-in-one AI platform for private document chat, no-code agents, and local LLMs with zero setup friction.

App
Built with
  • JavaScript 99%
Updated todayView details
TypeScript 72%Other

Budibase

28,427

Low Code Platforms · No Code Platforms

Build AI agents, automations, and internal apps on a single open-source platform with full self-hosting control.

App
Built with
  • TypeScript 72%
  • Svelte 24%
Updated yesterdayView details
TypeScript 99%AGPL 3.0

Cherry Studio

53,704

AI Assistants

All-in-one AI desktop client with 300+ assistants and multi-model support

App
Built with
  • TypeScript 99%
Updated todayView details
TypeScript 67%MIT

Ghost

55,872

Blogging · CMS

Open source headless Node.js CMS for professional publishing, paid memberships, and newsletters with a fully owned audience.

App
Built with
  • TypeScript 67%
  • JavaScript 30%
Updated todayView details
TypeScript 96%AGPL 3.0

HeyForm

9,082

Forms Surveys · No Code Platforms

Open-source conversational form builder with AI generation, conditional logic, and 30+ integrations — self-host with full data ownership.

App
Built with
  • TypeScript 96%
Updated todayView details
TypeScript 62%EPL-2.0

Huly Platform

28,160

Collaboration · Project Management · Team Chat

Open-source all-in-one workspace that replaces Linear, Jira, Slack, and Notion for product and engineering teams.

App
Built with
  • TypeScript 62%
  • Svelte 34%
Updated 1 weeks agoView details
TypeScript 98%AGPL 3.0

Karakeep

30,731

Bookmarks Archiving

Self-hosted bookmark manager that captures links, notes, images, and PDFs with AI tagging, full-text search, and automatic archiving.

App
Built with
  • TypeScript 98%
Updated yesterdayView details
TypeScript 99%Other

LobeHub

85,934

AI Assistants · Automation · Productivity

Your Chief Agent Operator — build, schedule, and collaborate with an entire AI team in one self-hostable workspace.

App
Built with
  • TypeScript 99%
Updated todayView details

Join founders building with open source

Opinionated takes, migration guides, cost-saving tips, and insights from the open source ecosystem.

Subscribe on SubstackJoin 750+ subscribers