Source

BlueCloth /

Filename Size Date modified Message
bin
experiments
ext
lib
spec
web
829 B
357 B
16.9 KB
1.5 KB
2.3 KB
2.1 KB
9.3 KB
1.4 KB
857 B
= BlueCloth 2

BlueCloth is a Ruby implementation of John Gruber's
Markdown[http://daringfireball.net/projects/markdown/], a text-to-HTML
conversion tool for web writers. To quote from the project page: Markdown
allows you to write using an easy-to-read, easy-to-write plain text format,
then convert it to structurally valid XHTML (or HTML).

It borrows a naming convention and several helpings of interface from
Redcloth[http://www.whytheluckystiff.net/ruby/redcloth/], 
{Why the Lucky Stiff}[http://www.whytheluckystiff.net/] 's processor for a 
similar text-to-HTML conversion syntax called 
Textile[http://www.textism.com/tools/textile/].

BlueCloth 2 is a complete rewrite using David Parsons' Discount library, a C
implementation of Markdown. I rewrote it using the extension for speed and
accuracy; the original BlueCloth was a straight port from the Perl version 
that I wrote in a few days for my own use just to avoid having to shell out 
to Markdown.pl, and it was quite buggy and slow. I apologize to all the good 
people that sent me patches for it that were never released.


== Authors

* Michael Granger (ged@FaerieMUD.org)


== Contributors

* Martin Chase <stillflame@FaerieMUD.org>
* Florian Gross <flgr@ccan.de>

This product includes software developed by David Loren 
Parsons <http://www.pell.portland.or.us/~orc>.


== Installation

If you use RubyGems, you can install it via:

  $ sudo gem install bluecloth

You can also install as a site library via the Rakefile:

  $ wget http://deveiate.org/code/bluecloth-x.y.z.tar.gz
  $ tar xzvf bluecloth-x.y.z.tar.gz
  $ cd bluecloth-x.y.z
  $ sudo rake install


== Source 

You can check out the current development source with Subversion from the
following URL:

  svn://deveiate.org/BlueCloth/trunk

You can report bugs, suggest improvements, or check on development activity at 
the project page:

  http://deveiate.org/projects/BlueCloth/


== License

See the LICENSE file included with the distribution for licensing and 
copyright details.

The licensing terms of Discount are described in the LICENSE.discount file, 
also included with the distribution.