public
Rubygem
Description: BlueCloth's evil twin - convert HTML into Markdown
Homepage: http://www.craigjolicoeur.com/clothblue
Clone URL: git://github.com/cpjolicoeur/clothblue.git
Search Repo:
Click here to lend your support to: clothblue and make a donation at www.pledgie.com !
name age message
folder README.markdown Fri Aug 22 13:38:58 -0700 2008 more readme updates [cpjolicoeur]
folder TODO Wed May 14 09:29:10 -0700 2008 update docs [cpjolicoeur]
folder clothblue.gemspec Wed May 14 13:03:15 -0700 2008 update to gemspec file [cpjolicoeur]
folder lib/ Fri Aug 22 13:27:01 -0700 2008 start rewrite of clothblue using parsehtml [cpjolicoeur]
folder test/ Wed May 14 09:29:20 -0700 2008 add initial test files [cpjolicoeur]
README.markdown

ClothBlue

HTML to Markdown library

What it is

A script to convert HTML into Markdown markup for use, for example, with BlueCloth.

Requirements

All you need is Ruby.

Get it

Available as a gem on GitHub: (coming soon)

Or download from: http://clothblue.rubyforge.org

Or get the source: http://github.com/cpjolicoeur/clothblue

Features

This is beta software, and only a few Markdown rules have been implemented yet:

  • font markup and weight (<b>, <strong>, ...)
  • text formatting (<sub>, <sup>, <ins>,<del>)

Usage

require 'clothblue'

text = ClothBlue.new("<b>Bold</b> <em>HTML</em>!")

text.to_markdown

Get Help

Feel free to contact me, or view the homepage.

  • http://craigjolicoeur.com/clothblue/
  • http://github.com/cpjolicoeur/clothblue/

Developers

License

MIT License

Copyright (c) 2008 Craig P Jolicoeur

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgments

ClothBlue received inspiration from the ClothRed library and the Markdownify PHP library.

Markdown is, of course, written by John Gruber. Michel Fortin's Markdown Extra support is also included.