Download
Redcarpet is written with sugar, spice and everything nice. Redcarpet is a Ruby library for Markdown processing that smells like butterflies and popcorn. Redcarpet would not be possible without the Sundown library and its authors (Natacha Porté, Vicent Martí, and its many awesome contributors). Redcarpet is readily available as a Ruby gem. It will build some native extensions, but the parser is standalone and requires no installed libraries. Starting with Redcarpet 3.0, the minimum required Ruby version is 1.9.2 (or Rubinius in 1.9 mode). The core of the Redcarpet library is the Redcarpet::Markdown class. Each instance of the class is attached to a Renderer object; the Markdown class performs parsing of a document and uses the attached renderer to generate output. Redcarpet comes with two built-in renderers, Redcarpet::Render::HTML and Redcarpet::Render::XHTML, which output HTML and XHTML, respectively.
Features
- Several degrees of magnitude faster than other Ruby Markdown solutions
- The HTML renderer has an alternate version
- Redcarpet also includes a plaintext renderer
- Custom renderers are created by inheriting from an existing renderer
- Redcarpet 2 comes with a standalone SmartyPants implementation
- Comes with SmartyPants, which works on top of already-rendered HTML
Project Samples
