Sha256: 5787517af60212b2481afb0ab626f8f9f829459813c919b6eee503345959da9c
Contents?: true
Size: 1.62 KB
Versions: 14
Compression:
Stored size: 1.62 KB
Contents
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][1] and
passes the [Markdown 1.0 test suite][2].
Discount was developed by [David Loren Parsons][3]. The Ruby extension was
developed by [Ryan Tomayko][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]: http://tomayko.com/
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](http://github.com/rtomayko/rdiscount).
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.
Version data entries
14 entries across 14 versions & 4 rubygems