https://github.com/bdurand/html_to_plain_text

A ruby gem that can convert HTML to formatted plain text.
https://github.com/bdurand/html_to_plain_text

Last synced: about 2 months ago
JSON representation

A ruby gem that can convert HTML to formatted plain text.

• Host: GitHub
• URL: https://github.com/bdurand/html_to_plain_text
• Owner: bdurand
• License: mit
• Created: 2011-06-06T16:42:21.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2019-02-14T01:18:00.000Z (over 5 years ago)
• Last Synced: 2024-07-17T10:13:24.283Z (2 months ago)
• Language: Ruby
• Homepage:
• Size: 16.6 KB
• Stars: 42
• Watchers: 2
• Forks: 16
• Open Issues: 3
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: CHANGES.txt

Awesome Lists containing this project

README

        
= HTML To Plain Text

gem install 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  elements will be honored

* Code-like tags like  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!"