Discount (For Ruby) Implementation of John Gruber's Markdown
Switch branches/tags
Nothing to show
Pull request Compare This branch is 220 commits behind davidfstr:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
ext
lib
test
.gitignore
COPYING
README.markdown
Rakefile

README.markdown

Discount Markdown Processor for Ruby

Discount is an implementation of John Gruber's Markdown markup language in C. It implements all of the language described in the markdown syntax document and passes the Markdown 1.0 test suite.

Discount was developed by David Loren Parsons. The Ruby extension was developed by Ryan Tomayko.

Installation, Hacking

RDiscount Gem releases are published to RubyForge and can be installed as follows:

$ [sudo] gem install rdiscount

The RDiscount sources are available via Git:

$ git clone git://github.com/rtomayko/rdiscount.git $ cd rdiscount $ rake --tasks

For more information, see the project page.

Usage

RDiscount implements the basic protocol popularized by RedCloth and adopted by BlueCloth:

require 'rdiscount' markdown = RDiscount.new("Hello World!") puts markdown.to_html

Inject RDiscount into your BlueCloth-using code by replacing your bluecloth require statements with the following:

begin require 'rdiscount' BlueCloth = RDiscount rescue LoadError require 'bluecloth' end

COPYING

Discount is free software; it is released under a BSD-style license that allows you to do as you wish with it as long as you don't attempt to claim it as your own work. RDiscount adopts Discount's license verbatim. See the file COPYING for more information.