public
Description: An implementation of markdown in C, using a PEG grammar
Clone URL: git://github.com/jgm/peg-markdown.git
Small fixes to README.
jgm (author)
Fri May 02 17:20:21 -0700 2008
commit  1bb0daff1333856b3518a69af913eb241398ee0d
tree    e5cf4196fd03b796954fd5cb590f92e96d1a4c00
parent  867af8c9c857006961e750468bf98e72f67d895d
0
...
1
2
3
4
 
5
6
7
8
9
...
14
15
16
17
18
 
 
19
20
21
...
25
26
27
28
 
29
30
31
32
 
33
34
35
36
37
 
38
39
40
...
44
45
46
47
48
49
50
 
 
 
 
51
52
53
...
63
64
65
66
 
 
67
68
69
...
1
2
3
 
4
5
 
6
7
8
...
13
14
15
 
 
16
17
18
19
20
...
24
25
26
 
27
28
29
30
 
31
32
33
34
35
 
36
37
38
39
...
43
44
45
 
 
 
 
46
47
48
49
50
51
52
...
62
63
64
 
65
66
67
68
69
0
@@ -1,9 +1,8 @@
0
 What is this?
0
 =============
0
 
0
-This is an implementation of John Gruber's markdown
0
+This is an implementation of John Gruber's "markdown"
0
 (http://daringfireball.net/projects/markdown/) in C.
0
-
0
 It uses a PEG grammar to define the syntax. This should allow easy
0
 modification and extension.
0
 
0
@@ -14,8 +13,8 @@ markdown. It does, however, use a fair amount of memory.
0
 Installing
0
 ==========
0
 
0
-The program is written in portable ANSI C. For convenience, two required
0
-dependencies are included in the source directory:
0
+This program is written in portable ANSI C. For convenience, two
0
+required dependencies are included in the source directory:
0
 
0
   * bsittler's my_getopt option parsing library
0
     (http://www.geocities.com/bsittler/)
0
@@ -25,16 +24,16 @@ dependencies are included in the source directory:
0
 
0
 These will be built automatically.
0
 
0
-To make the markdown executable:
0
+To make the 'markdown' executable:
0
 
0
     make
0
 
0
-To run John Gruber's markdown 1.0.3 test suite:
0
+To run John Gruber's Markdown 1.0.3 test suite:
0
 
0
     make test
0
 
0
 The test suite will fail on one of the list tests. Here's why.
0
-Markdown.pl encloses "item one" in the following list in <p> tags:
0
+Markdown.pl encloses "item one" in the following list in `<p>` tags:
0
 
0
     1. item one
0
         * subitem
0
@@ -44,10 +43,10 @@ Markdown.pl encloses "item one" in the following list in <p> tags:
0
 
0
     3. item three
0
 
0
-Here we do not enclose "item one" in <p> tags unless it has a following
0
-blank line. This is consistent with the official markdown syntax
0
-description, and lets the author of the document choose whether <p> tags
0
-are desired.
0
+peg-markdown does not enclose "item one" in <p> tags unless it has a
0
+following blank line. This is consistent with the official markdown
0
+syntax description, and lets the author of the document choose whether
0
+`<p>` tags are desired.
0
 
0
 Hacking
0
 =======
0
@@ -63,7 +62,8 @@ than HTML or LaTeX, and to parse syntax extensions. A quick guide:
0
   * To add syntax extensions, define them in the PEG grammar (bottom part
0
     of markdown.leg), using existing definitions as a guide. If you need
0
     to add new types of elements (e.g. FOOTNOTE), modify the 'keys'
0
- enum.
0
+ enum. By using `&{ }` rules it should be possible to selectively
0
+ disable extensions depending on command-line options.
0
 
0
   * Note: Avoid using [^abc] character classes in the grammar, because they
0
     cause problems with non-ascii input. Instead, use: ( !'a' !'b' !'c' . )

Comments

    No one has commented yet.