bluecloth.rb

Path: lib/bluecloth.rb
Last Update: Thu Oct 19 10:43:39 +0000 2006

Bluecloth is a Ruby implementation of Markdown, a text-to-HTML conversion tool.

Synopsis

  doc = BlueCloth::new "
    ## Test document ##

    Just a simple test.
  "

  puts doc.to_html

Authors

  • Michael Granger <ged@FaerieMUD.org>

Contributors

  • Martin Chase <stillflame@FaerieMUD.org> - Peer review, helpful suggestions
  • Florian Gross <flgr@ccan.de> - Filter options, suggestions

Copyright

Original version:

  Copyright (c) 2003-2004 John Gruber
  <http://daringfireball.net/>
  All rights reserved.

Ruby port:

  Copyright (c) 2004 The FaerieMUD Consortium.

BlueCloth is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

BlueCloth is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

To-do

  • Refactor some of the larger uglier methods that have to do their own brute-force scanning because of lack of Perl features in Ruby‘s Regexp class. Alternately, could add a dependency on ‘pcre’ and use most Perl regexps.
  • Put the StringScanner in the render state for thread-safety.

Version

 $Id: bluecloth.rb 69 2004-08-25 05:27:15Z ged $

Required files

digest/md5   logger   strscan  

[Validate]