kramdown

fast, pure-Ruby Markdown-superset converter

kramdown Documentation

Overview

kramdown is first and foremost a library for converting text written in a superset of Markdown to HTML. However, due to its modular architecture it is able to support additional input and output formats. The following input and output formats are currently supported:

The kramdown syntax page describes in detail what is supported and how it differs from standard Markdown.

For all available options have a look at the options documentation or have a look at a parser/converter page to see which options they support!

Usage

The kramdown package provides two ways for using it:

Tests

kramdown uses various test suites to verify the correct working of the parsers and converters. For more information, have a look at the tests document.