Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

kramdown is yet-another-markdown-parser but fast, pure Ruby, using a strict syntax definition and supporting several common extensions.

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 benchmark
Octocat-spinner-32 bin
Octocat-spinner-32 data
Octocat-spinner-32 doc
Octocat-spinner-32 lib
Octocat-spinner-32 man
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 AUTHORS
Octocat-spinner-32 COPYING
Octocat-spinner-32 GPL
Octocat-spinner-32 README
Octocat-spinner-32 Rakefile
Octocat-spinner-32 setup.rb
README
# 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.
Something went wrong with that request. Please try again.