Skip to content

Repository files navigation

html2text BuildGem Version

html2text is a very simple gem that uses DOM methods to convert HTML into a format similar to what would be rendered by a browser - perfect for places where you need a quick text representation. For example:

<html><title>Ignored Title</title><body><h1>Hello, World!</h1><p>This is some e-mail content.
Even though it has whitespace and newlines, the e-mail converter
will handle it correctly.
<p>Even mismatched tags.</p><div>A div</div><div>Another div</div><div>A div<div>within a div</div></div><ahref="https://foo.com">A link</a></body></html>

Will be converted into:

Hello, World!
This is some e-mail content. Even though it has whitespace and newlines, the e-mail converter will handle it correctly.
Even mismatched tags.
A div
Another div
A div
within a div
[A link](https://foo.com)

See the original blog post or the related StackOverflow answer.

Installing

Add the gem into your Gemfile and run bundle install:

gem'html2text'

Then you can:

require'html2text'text=Html2Text.convert(html)

Tests

See all of the test cases defined in spec/examples/. These can be run with bundle exec rake.

License

html2text is licensed under MIT.

Other versions

  1. html2text, the original PHP implementation.
  2. actionmailer-html2text, automatically generate text parts for HTML emails sent with ActionMailer.

About

A Ruby component to convert HTML into a plain text format.

Resources

Stars

46 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages