Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 57 lines (37 sloc) 1.255 kB
72d557e @rtomayko Version 1.0
authored
1 Ruby PEG Markdown
2 =================
3
4 An extension library around [John MacFarlane's fast implementation][1]
5 of Markdown in C.
6
7 [1]: http://github.com/jgm/peg-markdown/
8
9 Synopsis
10 --------
11
12 >> require 'markdown'
13 >> puts Markdown.new('Hello, world.').to_html
14 <p>Hello, world.</p>
15
16 >> puts Markdown.new('_Hello World!_', :smart, :filter_html).to_html
17 <p><em>Hello World!</em></p>
18
26578d3 @jgm Added to_latex and to_groff_mm methods to PEGMarkdown class.
jgm authored
19 >> puts Markdown.new('_Hello World!_').to_latex
20 \emph{Hello World!}
21
22 >> puts Markdown.new('_Hello World!_').to_groff_mm
23 .P
24 \fIHello world!\fR
25
72d557e @rtomayko Version 1.0
authored
26 >> PEGMarkdown.new('Hello! World!')
27
28 Installation / Hacking
29 ----------------------
30
31 This library requires a recent version of glib2. All modern GNU userland
32 systems should be fine.
33
34 Install from GEM:
35
36 $ sudo gem install rpeg-markdown
37
38 Hacking:
39
40 $ git clone git://github.com/rtomayko/rpeg-markdown.git
41 $ cd rpeg-markdown
42 $ rake test
43
44 Patches happily accepted via fork or email.
45
46 Changes
47 -------
48
49 * [Version 1.0](http://github.com/rtomayko/rpeg-markdown/tree/v1.0)
50
51 COPYING
52 -------
53
54 The peg-markdown sources are licensed under the GPL and the Ruby PEG Markdown
55 extension sources adopts this license. See the file LICENSE included with this
56 distribution for more information.
Something went wrong with that request. Please try again.