summaryrefslogtreecommitdiff
path: root/doc/markdown
diff options
context:
space:
mode:
authorRaniere Silva <raniere@ime.unicamp.br>2015-06-26 19:37:22 -0300
committerRaniere Silva <raniere@ime.unicamp.br>2015-07-03 15:27:24 -0300
commitb348ff1a10aca42016a995f1477c63e3aa2690a4 (patch)
treecc524445c61511fed1b411fa45f8c6f8d3ee8998 /doc/markdown
parent9f166a864959370d3e31931519506887b902cd11 (diff)
downloadgitlab-ce-b348ff1a10aca42016a995f1477c63e3aa2690a4.tar.gz
Improve documentation of lists in Markdown
Diffstat (limited to 'doc/markdown')
-rw-r--r--doc/markdown/markdown.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md
index 9c7f723c06d..322111ae9e1 100644
--- a/doc/markdown/markdown.md
+++ b/doc/markdown/markdown.md
@@ -343,6 +343,36 @@ Strikethrough uses two tildes. ~~Scratch this.~~
- Or minuses
+ Or pluses
+If a list item contains multiple paragraphs,
+each subsequent paragraph should be indented with four spaces.
+
+```no-highlight
+1. First ordered list item
+
+ Second paragraph of first item.
+2. Another item
+```
+
+1. First ordered list item
+
+ Second paragraph of first item.
+2. Another item
+
+If the second paragraph isn't indented with four spaces,
+the second list item will be incorrectly labeled as `1`.
+
+```no-highlight
+1. First ordered list item
+
+ Second paragraph of first item.
+2. Another item
+```
+
+1. First ordered list item
+
+ Second paragraph of first item.
+2. Another item
+
## Links
There are two ways to create links, inline-style and reference-style.