0
-This is an implementation of John Gruber's
markdown0
+This is an implementation of John Gruber's
"markdown"0
(http://daringfireball.net/projects/markdown/) in C.
0
It uses a PEG grammar to define the syntax. This should allow easy
0
modification and extension.
0
@@ -14,8 +13,8 @@ markdown. It does, however, use a fair amount of memory.
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
* 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
These will be built automatically.
0
-To make the
markdown executable:
0
+To make the
'markdown' executable:
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
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
@@ -44,10 +43,10 @@ Markdown.pl encloses "item one" in the following list in <p> tags:
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
+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
@@ -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. By using `&{ }` rules it should be possible to selectively
0
+ disable extensions depending on command-line options.
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.