HTML To Plain Text

A simple gem that provide code to convert HTML into a plain text alternative. Line breaks from HTML block level elements will be maintained. Lists and tables will also maintain a little bit of formatting.

• Line breaks will be approximated using the generally established default margins for HTML tags (i.e.

  tag generates two line breaks,

  generates one)
• Lists items will be numbered or bulleted with an asterisk
• 
  tags will add line breaks

• ---

  tags will add a string of hyphens to serve as a horizontal rule
• elements will enclosed in "|" delimiters
• tags will have the href URL appended to the text in parentheses
• Formatting tags like or will be stripped
• Formatting inside

   or <plaintext> elements will be honored

• Code-like tags like <script> or <style> will be stripped

Usage

require 'html_to_plain_text'

html = "<h1>Hello</h1><p>world!</p>"
HtmlToPlainText.plain_text(html) # => "Hello\n\nworld!"

Installation

Add this line to your application's Gemfile:

gem "html_to_plain_text"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install html_to_plain_text

Contributing

Open a pull request on GitHub.

Please use the standardrb syntax and lint your code with standardrb --fix before submitting.

License

The gem is available as open source under the terms of the MIT License.