summaryrefslogtreecommitdiff
path: root/doc/markdown
diff options
context:
space:
mode:
authorVinnie Okada <vokada@mrvinn.com>2014-10-05 22:04:58 -0500
committerVinnie Okada <vokada@mrvinn.com>2014-10-05 22:15:36 -0500
commit3a3b2eb33e2ca41153a960b89ae7796b43aa93e8 (patch)
tree02872dfa6b33c1caa3247d2653ab375eabcefdcf /doc/markdown
parentfecd9c0cb22eda0a208042c568d8d833a1bd6292 (diff)
downloadgitlab-ce-3a3b2eb33e2ca41153a960b89ae7796b43aa93e8.tar.gz
Update docs for task lists
Diffstat (limited to 'doc/markdown')
-rw-r--r--doc/markdown/markdown.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md
index 5c095ed1487..6d96da76ad7 100644
--- a/doc/markdown/markdown.md
+++ b/doc/markdown/markdown.md
@@ -10,6 +10,7 @@
* [Code and Syntax Highlighting](#code-and-syntax-highlighting)
* [Emoji](#emoji)
* [Special GitLab references](#special-gitlab-references)
+* [Task lists](#task-lists)
**[Standard Markdown](#standard-markdown)**
@@ -183,6 +184,18 @@ GFM also recognizes references to commits, issues, and merge requests in other p
- namespace/project!123 : for merge requests
- namespace/project@1234567 : for commits
+## Task Lists
+
+You can add task lists to merge request and issue descriptions to keep track of to-do items. To create a task, add an unordered list to the description in an issue or merge request, formatted like so:
+
+```no-highlight
+* [x] Completed task
+* [ ] Unfinished task
+ * [x] Nested task
+```
+
+Task lists can only be created in descriptions, not in titles or comments. Task item state can be managed by editing the description's Markdown or by clicking the rendered checkboxes.
+
# Standard Markdown
## Headers