aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2011-01-28 11:55:11 -0800
committerJohn MacFarlane <jgm@berkeley.edu>2011-01-28 12:02:26 -0800
commit8c435578d63b4723789b5d03d36c8da19968af8e (patch)
treef0c937228ad74f775390ee5e5fd6b0b99cefb2a1 /README
parent5ba5373ec66dfbafc16e28320851d70e1be46f80 (diff)
downloadpandoc-8c435578d63b4723789b5d03d36c8da19968af8e.tar.gz
Refactored man pages.
* Markdown syntax description from README now goes in pandoc_markdown.5. * Refactored man page construction functions, putting more of the work in MakeManPages.hs.
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 10 insertions, 11 deletions
diff --git a/README b/README
index bdfdeab67..bd098e73b 100644
--- a/README
+++ b/README
@@ -22,9 +22,9 @@ Pandoc's enhanced version of markdown includes syntax for footnotes,
tables, flexible ordered lists, definition lists, delimited code blocks,
superscript, subscript, strikeout, title blocks, automatic tables of
contents, embedded LaTeX math, citations, and markdown inside HTML block
-elements. (These enhancements, described below under [Pandoc's markdown
-vs. standard markdown](#pandocs-markdown-vs.-standard-markdown),
-can be disabled using the `--strict` option.)
+elements. (These enhancements, described below under
+[Pandoc's markdown](#pandocs-markdown), can be disabled using the `--strict`
+option.)
In contrast to most existing tools for converting markdown to HTML, which
use regex substitutions, Pandoc has a modular design: it consists of a
@@ -549,15 +549,14 @@ consecutive items:
$for(author)$$author$$sep$, $endfor$
-Pandoc's markdown vs. standard markdown
-=======================================
+Pandoc's markdown
+=================
-In parsing markdown, Pandoc departs from and extends [standard markdown]
-in a few respects. Except where noted, these differences can
-be suppressed by specifying the `--strict` command-line option.
-
-[standard markdown]: http://daringfireball.net/projects/markdown/syntax
- "Markdown syntax description"
+Pandoc understands an extended and slightly revised version of
+John Gruber's [markdown] syntax. This document explains the syntax,
+noting differences from standard markdown. Except where noted, these
+differences can be suppressed by specifying the `--strict` command-line
+option.
Backslash escapes
-----------------