summaryrefslogtreecommitdiff
path: root/doc/markdown
diff options
context:
space:
mode:
authorDouwe Maan <douwe@gitlab.com>2016-07-22 20:30:02 +0000
committerDouwe Maan <douwe@gitlab.com>2016-07-22 20:30:02 +0000
commit0d80354df79ae3e75f7a415b2089ee3359a65046 (patch)
tree8f356b8e63d4d07503ed25bad5298ff3a8a03c00 /doc/markdown
parent9ccfac275f203459c67290ab3d5f69ac09085276 (diff)
downloadgitlab-ce-0d80354df79ae3e75f7a415b2089ee3359a65046.tar.gz
Add note to say GFM doesn't work on documentation website
Diffstat (limited to 'doc/markdown')
-rw-r--r--doc/markdown/markdown.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/markdown/markdown.md b/doc/markdown/markdown.md
index 2bbe4b2a36e..1761487b6ca 100644
--- a/doc/markdown/markdown.md
+++ b/doc/markdown/markdown.md
@@ -1,5 +1,10 @@
# Markdown
+> **Note:**
+> Not all of the GitLab-specific extensions to Markdown that are described in this document currently work on our documentation website.
+>
+> For the best result, we encourage you to check this document out as rendered by GitLab: [markdown.md](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/markdown/markdown.md).
+
## Table of Contents
**[GitLab Flavored Markdown](#gitlab-flavored-markdown-gfm)**