Sha256: 1adf4edeeb3661b3694975f298007579844e9eff46782a71811ebb3d4b0a8766

Contents?: true

Size: 1.65 KB

Versions: 1

Compression:

Stored size: 1.65 KB

Contents

Ruby PEG MultiMarkdown
======================

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

[1]: http://github.com/fletcher/peg-multimarkdown/
[2]: http://github.com/rtomayko/rpeg-markdown
[3]: http://github.com/jgm/peg-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.1.1](http://github.com/djungelvral/rpeg-multimarkdown/tree/v0.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.

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
rpeg-multimarkdown-0.2 README.markdown