oawhyte / rpeg-multimarkdown

MultiMarkdown module for ruby, by porting rpeg-markdown to use peg-multimarkdown

Ruby PEG MultiMarkdown

An extension library around Fletcher Penney's implementation of MultiMarkdown in C. This library is based (almost entirely) on rpeg-markdown, which is a ruby extension library around John MacFarlane's C implementation of Markdown.

Synopsis

>> require 'multimarkdown'

>> puts MultiMarkdown.new('Hello, world.').to_html
# <p>Hello, world.</p>

>> puts MultiMarkdown.new('_Hello World!_', :smart, :filter_html).to_html
# <p><em>Hello World!</em></p>

>> puts MultiMarkdown.new('_Hello World!_').to_latex
# \emph{Hello World!}

>> puts MultiMarkdown.new("Title: Some document\n\nSome text in the document").extract_metadata("title")
# Some document

>> PEGMultiMarkdown.new('Hello! World!')

Installation / Hacking

This library requires a recent version of glib2. All modern GNU userland systems should be fine.

Install from GEM:

$ sudo gem install rpeg-multimarkdown

Hacking:

$ git clone git://github.com/djungelvral/rpeg-multimarkdown.git
$ cd rpeg-multimarkdown
$ git submodule init
$ git submodule update
$ rake test

Changes

• Version 0.2.2
  • Bringing everything up to date with the last version of peg-multimarkdown
  • Fixed ruby module tests, which weren't actually running
  • Preserve encoding, e.g. for UTF-8
• Version 0.1.1

COPYING

The peg-markdown, peg-multimarkdown, and Ruby PEG Markdown extension sources are licensed under the GPL and the Ruby PEG MultiMarkdown extension sources adopts this license. See the file LICENSE included with this distribution for more information.