Last Modified
2013-07-14 07:28:32 +0000
Requires
  • kramdown/compatibility
  • kramdown/version
  • kramdown/element
  • kramdown/error
  • kramdown/parser
  • kramdown/converter
  • kramdown/options
  • kramdown/utils
  • rbconfig

Description

kramdown

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

The kramdown library is mainly written to support the kramdown-to-HTML conversion chain. However, due to its flexibility it supports other input and output formats as well. Here is a list of the supported formats:

All the documentation on the available input and output formats is available at 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

For detailed information have a look at the Kramdown::Document class.

License

MIT - see the COPYING file.