Discount Markdown Processor for Ruby ==================================== [![Build Status](https://travis-ci.org/davidfstr/rdiscount.svg?branch=master)](https://travis-ci.org/davidfstr/rdiscount) [![Build status](https://ci.appveyor.com/api/projects/status/47i0qxrnvjbg724f/branch/master?svg=true)](https://ci.appveyor.com/project/DavidFoster/rdiscount/branch/master) 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][1] and passes the [Markdown 1.0 test suite][2]. CODE: `git clone git://github.com/davidfstr/rdiscount.git` HOME: <http://dafoster.net/projects/rdiscount/> DOCS: <http://rdoc.info/github/davidfstr/rdiscount/master/RDiscount> BUGS: <http://github.com/davidfstr/rdiscount/issues> Discount was developed by [David Loren Parsons][3]. The Ruby extension is maintained by [David Foster][4]. [1]: http://daringfireball.net/projects/markdown/syntax [2]: http://daringfireball.net/projects/downloads/MarkdownTest_1.0.zip [3]: http://www.pell.portland.or.us/~orc [4]: https://github.com/davidfstr INSTALL, HACKING ---------------- New releases of RDiscount are published to [RubyGems][]: $ [sudo] gem install rdiscount The RDiscount sources are available via Git: $ git clone git://github.com/davidfstr/rdiscount.git $ cd rdiscount $ rake --tasks See the file [BUILDING][] for hacking instructions. [RubyGems]: https://rubygems.org/gems/rdiscount [BUILDING]: https://github.com/davidfstr/rdiscount/blob/master/BUILDING USAGE ----- RDiscount implements the basic protocol popularized by RedCloth and adopted by BlueCloth: require 'rdiscount' markdown = RDiscount.new("Hello World!") puts markdown.to_html Additional processing options can be turned on when creating the RDiscount object: markdown = RDiscount.new("Hello World!", :smart, :filter_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.