BlueCloth

BlueCloth is a Ruby implementation of Markdown, a text-to-HTML conversion tool for web writers. 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).

See the AboutMarkdown page for an example of the syntax.

Benchmarks

Here's a benchmark that compares the render time of all the Ruby Markdown implementations I know about, generated using this script:

$ experiments/benchmark.rb 
Markdown -> HTML, 100 iterations (experiments/benchmark.txt, 8064 bytes)
Rehearsal --------------------------------------------------------------------
OldBlueCloth (1.1.0)              11.160000   1.040000  12.200000 ( 12.546876)
BlueCloth (2.0.2)                  0.050000   0.000000   0.050000 (  0.057174)
RDiscount (1.3.4)                  0.060000   0.010000   0.070000 (  0.060261)
Maruku (3.1.7.2)                   6.350000   0.050000   6.400000 (  6.546853)
PEGMarkdown (1.4.4)                0.580000   0.010000   0.590000 (  0.588281)
BlueFeather (0.21)                14.390000   0.940000  15.330000 ( 15.359384)
Tartan::Markdown::Parser (0.2.1)  16.230000   0.230000  16.460000 ( 16.572897)
---------------------------------------------------------- total: 51.100000sec

                                       user     system      total        real
OldBlueCloth (1.1.0)              10.970000   1.020000  11.990000 ( 12.055974)
BlueCloth (2.0.2)                  0.060000   0.000000   0.060000 (  0.057727)
RDiscount (1.3.4)                  0.060000   0.000000   0.060000 (  0.061195)
Maruku (3.1.7.2)                   6.180000   0.050000   6.230000 (  6.247997)
PEGMarkdown (1.4.4)                0.580000   0.010000   0.590000 (  0.586134)
BlueFeather (0.21)                14.130000   1.120000  15.250000 ( 15.562817)
Tartan::Markdown::Parser (0.2.1)  16.410000   0.300000  16.710000 ( 17.152420)

Links

Here are some other projects that use BlueCloth:

• Instiki - http://www.instiki.org/
• Eribium - http://www.eribium.org/
• Pimki - http://pimki.rubyforge.org/

Downloads

• RubyGem: BlueCloth-1.0.0.gem (64.65 k)
• Tar+Bzip2: BlueCloth-1.0.0.tar.bz2 (39.60 k)
• Tar+Gzip: BlueCloth-1.0.0.tar.gz (43.15 k)
• Zip: BlueCloth-1.0.0.zip (49.28 k)
• RubyGem: bluecloth-2.0.2.gem (111.50 k)
• Tar+Bzip2: bluecloth-2.0.2.tar.bz2 (89.73 k)
• Tar+Gzip: bluecloth-2.0.2.tar.gz (100.22 k)
• Zip: bluecloth-2.0.2.zip (144.20 k)
• RubyGem: bluecloth-2.0.3.gem (113.00 k)
• Tar+Bzip2: bluecloth-2.0.3.tar.bz2 (91.27 k)
• Tar+Gzip: bluecloth-2.0.3.tar.gz (102.38 k)
• Zip: bluecloth-2.0.3.zip (147.52 k)
• RubyGem: bluecloth-2.0.4.gem (114.50 k)
• Tar+Bzip2: bluecloth-2.0.4.tar.bz2 (92.36 k)
• Tar+Gzip: bluecloth-2.0.4.tar.gz (103.47 k)
• Zip: bluecloth-2.0.4.zip (149.91 k)

Development

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

svn://deveiate.org/BlueCloth/trunk

Trac Information

• TracGuide -- Built-in Documentation
• The Trac project -- Trac Open Source Project
• Trac FAQ -- Frequently Asked Questions
• TracSupport -- Trac Support

For a complete list of local wiki pages, see TitleIndex.