Sha256: 5576bdb52c1c32e0524701398af38a27760e0afce3eaf2485e16eb55861ee92a
Contents?: true
Size: 872 Bytes
Versions: 5
Compression:
Stored size: 872 Bytes
Contents
# kramdown
kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and
supporting several common extensions.
The syntax definition can be found in doc/syntax.page, a quick reference in doc/quickref.page. All
the documentation is available online at http://kramdown.rubyforge.org.
# Usage
kramdown has a basic *Cloth API, so using kramdown is as easy as
require 'kramdown'
Kramdown::Document.new(text).to_html
# Development
Just clone the git repository as described in doc/installation.page you are good to go. You probably
want to install `rake` so that you can use the provided rake tasks. Aside from that:
* The `tidy` binary needs to be installed for the automatically derived tests to work.
* The `latex` binary needs to be installed for the latex-compilation tests to work.
# License
See the COPYING file.
Version data entries
5 entries across 5 versions & 2 rubygems