rdiscount.rb

lib/tilt/rdiscount.rb

RDiscount (markdown, md, mkd) ↑

Markdown is a lightweight markup language, created by John Gruber and Aaron Swartz. For any markup that is not covered by Markdown’s syntax, HTML is used. Marking up plain text with Markdown markup is easy and Markdown formatted texts are readable.

RDiscount is a simple text filter. It does not support scope or locals. The :smart and :filter_html options may be set true to enable those flags on the underlying RDiscount object.

Example ↑

Hello Markdown Templates
========================

Hello World. This is a paragraph.

Usage ↑

To wrap a Markdown formatted document with a layout:

layout = Tilt['erb'].new do
  "<!doctype html><title></title><%= yield %>"
end
data = Tilt['md'].new { "# hello tilt" }
layout.render { data.render }
# => "<!doctype html><title></title><h1>hello tilt</h1>\n"

Options ↑

:smartypants => true|false ↑

Set true to enable [Smarty Pants] style punctuation replacement.

:escape_html => true|false ↑

Set true disallow raw HTML in Markdown contents. HTML is converted to literal text by escaping < characters.

See also ↑

* {Markdown Syntax Documentation}[http://daringfireball.net/projects/markdown/syntax]
* [Discount][discount]
* {RDiscount}[http://github.com/rtomayko/rdiscount]
Discount][discount

is an implementation of the Markdown markup language in C.

RDiscount][rdiscount

is a Ruby wrapper around Discount.

All the documentation of Markdown applies in addition to the following:

Usage ↑

The Tilt::RDiscountTemplate class is registered for all files ending in .markdown, .md or .mkd by default with the highest priority. If you specifically want to use RDiscount, it’s recommended to use prefer:

Tilt.prefer Tilt::RDiscountTemplate

NOTE: It’s suggested that your program require 'rdiscount' at load time when using this template engine within a threaded environment.

Required files

  1. rdiscount