public
Description: Discount (For Ruby) Implementation of John Gruber's Markdown
Homepage: http://github.com/rtomayko/rdiscount/
Clone URL: git://github.com/rtomayko/rdiscount.git
Search Repo:
name age message
folder .gitignore Tue Jun 03 03:59:06 -0700 2008 Rename Discount as RDiscount [rtomayko]
folder COPYING Thu May 29 19:51:11 -0700 2008 initial commit of discount ruby extension at 1.2.6 [rtomayko]
folder README.markdown Sat Aug 02 00:08:49 -0700 2008 tweak README a bit [rtomayko]
folder Rakefile Tue Aug 26 17:57:28 -0700 2008 version 1.2.9 [rtomayko]
folder bin/ Tue Jun 03 03:59:06 -0700 2008 Rename Discount as RDiscount [rtomayko]
folder ext/ Tue Aug 26 17:57:28 -0700 2008 support filter_html - converts tags to text [rtomayko]
folder lib/ Tue Aug 26 17:57:28 -0700 2008 support filter_html - converts tags to text [rtomayko]
folder test/ Tue Aug 26 17:57:28 -0700 2008 support filter_html - converts tags to text [rtomayko]
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.