BlueCloth's evil twin - convert HTML into Markdown
PHP Perl Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
README.markdown
TODO
clothblue.gemspec

README.markdown

BEWARE: THIS CODE IS NOT CURRENTLY FUNCTIONAL

ClothBlue is currently undergoing a major rewrite and the code currently on GitHub is almost certainly non-functional.

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.

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.

All attempts have been made to pass Michel Fortin's MDTest Suite as well.