This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
55 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
Ruby PEG Markdown | ||
================= | ||
|
||
An extension library around [John MacFarlane's fast implementation][1] | ||
of Markdown in C. | ||
|
||
[1]: http://github.com/jgm/peg-markdown/ | ||
|
||
Synopsis | ||
-------- | ||
|
||
>> require 'markdown' | ||
>> puts Markdown.new('Hello, world.').to_html | ||
<p>Hello, world.</p> | ||
|
||
>> puts Markdown.new('_Hello World!_', :smart, :filter_html).to_html | ||
<p><em>Hello World!</em></p> | ||
|
||
>> PEGMarkdown.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-markdown | ||
|
||
Hacking: | ||
|
||
$ git clone git://github.com/rtomayko/rpeg-markdown.git | ||
$ cd rpeg-markdown | ||
$ rake test | ||
|
||
Patches happily accepted via fork or email. | ||
|
||
Changes | ||
------- | ||
|
||
* [Version 1.0](http://github.com/rtomayko/rpeg-markdown/tree/v1.0) | ||
|
||
COPYING | ||
------- | ||
|
||
The peg-markdown sources are licensed under the GPL and the Ruby PEG Markdown | ||
extension sources adopts this license. See the file LICENSE included with this | ||
distribution for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters