diff --git a/doc/user/markdown.md b/doc/user/markdown.md index fb7116e8e466ef96f0683581b16ffc33ede6633a..42997590c5d0d70381310fc31a8f16b2deefd437 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -172,6 +172,11 @@ The IDs are generated from the content of the heading according to the following Example: + + ```markdown # This heading has spaces in it ## This heading has a :thumbsup: in it @@ -291,6 +296,11 @@ dealing with code and names that often appear with multiple underscores. GitLab Flavored Markdown ignores multiple underlines in words, to allow better rendering of Markdown documents discussing code: + + ```markdown perform_complicated_task @@ -331,6 +341,11 @@ With inline diff tags, you can display `{+ additions +}` or `[- deletions -]`. The wrapping tags can be either curly braces or square brackets: + + ```markdown - {+ addition 1 +} - [+ addition 2 +] @@ -354,6 +369,11 @@ However, you cannot mix the wrapping tags: Diff highlighting doesn't work with `` `inline code` ``. If your text includes backticks (`` ` ``), [escape](#escape-characters) each backtick with a backslash ` \ `: + + ```markdown - {+ Just regular text +} - {+ Text with `backticks` inside +} @@ -621,6 +641,11 @@ in an issue, merge request, epic, or comment has no effect. To create a task list, follow the format of an ordered or unordered list: + + ```markdown - [x] Completed task - [~] Inapplicable task @@ -1576,6 +1601,11 @@ is rendered inline with the text. Math written between double dollar signs (`$$...$$`) or in a [code block](#code-spans-and-blocks) with the language declared as `math` is rendered on a separate line: + + `````markdown This math is inline: $`a^2+b^2=c^2`$. @@ -1640,6 +1670,11 @@ For more information, see [issue 359077](https://gitlab.com/gitlab-org/gitlab/-/ {{< /alert >}} + + ```markdown This is an intro sentence to my wiki page. @@ -1670,6 +1705,11 @@ You can use alerts in any text box that supports Markdown. You can use the following types of alerts: + + - Note: information that users should take into account, even when skimming: ```markdown