summaryrefslogtreecommitdiff
path: root/doc/user/markdown.md
diff options
context:
space:
mode:
authorBrett Walker <bwalker@gitlab.com>2018-09-06 16:52:18 +0000
committerSean McGivern <sean@mcgivern.me.uk>2018-09-06 16:52:18 +0000
commitb0be58a1b313df976ea4b0e37163f8fea81ce5f4 (patch)
tree9f24d3c53f6d47fb6266f00db9f60f514447ed2a /doc/user/markdown.md
parent2d16f4794b43966595e8c6b6405b55c60e94e866 (diff)
downloadgitlab-ce-b0be58a1b313df976ea4b0e37163f8fea81ce5f4.tar.gz
Resolve "CE documentation is not CommonMark compliant"
Diffstat (limited to 'doc/user/markdown.md')
-rw-r--r--doc/user/markdown.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md
index e9c8980a3e6..fb132f0613b 100644
--- a/doc/user/markdown.md
+++ b/doc/user/markdown.md
@@ -66,15 +66,15 @@ GFM honors the markdown specification in how [paragraphs and line breaks are han
A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines.
Line-breaks, or soft returns, are rendered if you end a line with two or more spaces:
-[//]: # (Do *NOT* remove the two ending whitespaces in the following line.)
-[//]: # (They are needed for the Markdown text to render correctly.)
+<!-- (Do *NOT* remove the two ending whitespaces in the following line.) -->
+<!-- (They are needed for the Markdown text to render correctly.) -->
Roses are red [followed by two or more spaces]
Violets are blue
Sugar is sweet
-[//]: # (Do *NOT* remove the two ending whitespaces in the following line.)
-[//]: # (They are needed for the Markdown text to render correctly.)
+<!-- (Do *NOT* remove the two ending whitespaces in the following line.) -->
+<!-- (They are needed for the Markdown text to render correctly.) -->
Roses are red
Violets are blue
@@ -472,7 +472,7 @@ Become:
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15107) in
GitLab 10.3.
-
+>
> If this is not rendered correctly, see
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#mermaid