aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn MacFarlane <fiddlosopher@gmail.com>2011-10-28 13:24:39 -0700
committerJohn MacFarlane <fiddlosopher@gmail.com>2011-10-28 13:24:39 -0700
commit195f9045a4a7f530ee4e1ba8ca55f4a49fd72f9a (patch)
tree5fc05a5c6bcbb37e1c79f26de534b88c24faf5d1
parentf4dbd853474e044c426e6c2fc293e6529ad517e0 (diff)
downloadpandoc-195f9045a4a7f530ee4e1ba8ca55f4a49fd72f9a.tar.gz
Clarified rule for first line of definition lists.
Closes #310.
-rw-r--r--README8
1 files changed, 5 insertions, 3 deletions
diff --git a/README b/README
index 5d8778daf..d36068dfa 100644
--- a/README
+++ b/README
@@ -1027,9 +1027,11 @@ Pandoc supports definition lists, using a syntax inspired by
Each term must fit on one line, which may optionally be followed by
a blank line, and must be followed by one or more definitions.
A definition begins with a colon or tilde, which may be indented one
-or two spaces. A term may have multiple definitions, and each definition
-may consist of one or more block elements (paragraph, code block, list,
-etc.), each indented four spaces or one tab stop.
+or two spaces. The body of the definition (including the first line,
+aside from the colon or tilde) should be indented four spaces. A term may have
+multiple definitions, and each definition may consist of one or more block
+elements (paragraph, code block, list, etc.), each indented four spaces or one
+tab stop.
If you leave space after the definition (as in the example above),
the blocks of the definitions will be considered paragraphs. In some