aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2013-02-21 12:37:07 -0500
committerWaylan Limberg <waylan@gmail.com>2013-02-21 12:37:07 -0500
commit067653954bda97bbf6e9060cc4052627fbdab84b (patch)
tree9a0f2d78d332f3a884fffa3acf92d103a57b05c4
parent96bdb78e148acff2a6ae7d425ef80ca8553aeff0 (diff)
downloadmarkdown-067653954bda97bbf6e9060cc4052627fbdab84b.tar.gz
markdown-067653954bda97bbf6e9060cc4052627fbdab84b.tar.bz2
markdown-067653954bda97bbf6e9060cc4052627fbdab84b.zip
Better clarify the 4 space indentation rule.
A better explanation for #193 that includes all block-level elements nested in lists.
-rw-r--r--docs/index.txt12
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/index.txt b/docs/index.txt
index d13ab0d..b0372d8 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -90,18 +90,16 @@ are summarized below:
subsequent paragraph in a list item **must** be indented by either 4 spaces
or one tab" (emphasis added). However, many implementations do not enforce
this rule and allow less than 4 spaces of indentation. The implementers of
- Python-Markdown consider it a bug to not enforce this rule, and therefore,
- subsequent paragraphs of a list **must** be indented by four spaces or one
- tab.
+ Python-Markdown consider it a bug to not enforce this rule.
- The same strict behavior is enforced on nested lists in Python-Markdown.
- A sublist item **must** be nested by at last four spaces. To do otherwise
- would be considered a bug.
+ This applies to any block level elements nested in a list, including
+ paragraphs, sub-lists, blockquotes, code blocks, etc. They **must** always
+ be indented by at least four spaces (or one tab) for each level of nesting.
In the event that one would prefer different behavior,
[tab_length](reference.html#tab_length) can be set to whatever length is
desired. Be warned however, as this will affect indentation for all aspects
- of the syntax (including code blocks).
+ of the syntax (including root level code blocks).
* __Consecutive Lists__