summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2015-08-06 10:30:22 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2015-08-06 10:30:22 -0700
commit3e8590d8a47be8e45fb20f25530399b2134a52ab (patch)
tree3f2b3eec710cce4172edc7af39d943a413acc195 /README
parente3b791eda7e858e568a345882cb83e3d3220c7e7 (diff)
Clarify docs on block quotes.
The space after `>` is optional. Closes #2346.
Diffstat (limited to 'README')
-rw-r--r--README11
1 files changed, 9 insertions, 2 deletions
diff --git a/README b/README
index 8ece8efdc..6164693b9 100644
--- a/README
+++ b/README
@@ -1295,8 +1295,8 @@ Block quotations
Markdown uses email conventions for quoting blocks of text.
A block quotation is one or more paragraphs or other block elements
(such as lists or headers), with each line preceded by a `>` character
-and a space. (The `>` need not start at the left margin, but it should
-not be indented more than three spaces.)
+and an optional space. (The `>` need not start at the left margin, but
+it should not be indented more than three spaces.)
> This is a block quote. This
> paragraph has two lines.
@@ -1320,6 +1320,13 @@ other block quotes. That is, block quotes can be nested:
>
> > A block quote within a block quote.
+If the `>` character is followed by an optional space, that space
+will be considered part of the block quote marker and not part of
+the indentation of the contents. Thus, to put an indented code
+block in a block quote, you need five spaces after the `>`:
+
+ > code
+
#### Extension: `blank_before_blockquote` ####
Standard markdown syntax does not require a blank line before a block