kramdown.rb

lib/tilt/kramdown.rb

Markdown (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.

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 ↑

Every implementation of Markdown should support these options, but there are some known problems with the Kramdown engine.

:smartypants => true|false ↑

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

In Kramdown this option only applies to smart quotes. It will apply a subset of Smarty Pants (e.g. ... to …) regardless of any option.

:escape_html => true|false ↑

Kramdown doesn’t support this option.

See also ↑

Required files

  1. kramdown