diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-16 06:09:46 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-12-16 06:09:46 +0300 |
commit | 6aaf8cf6f4a561152e9b08b4a6470ad88195cd2f (patch) | |
tree | 9f7f10bb03e3f71e9bdce6c07631a17cd2152aca /doc/user/markdown.md | |
parent | eba30e2ad821f653970486c4122fcca22cee27d9 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/markdown.md')
-rw-r--r-- | doc/user/markdown.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 15bb77efa17..d0a032a24e5 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -7,9 +7,9 @@ type: reference, howto # GitLab Markdown -This Markdown guide is **valid only for GitLab's internal Markdown rendering system for entries and files**. +This Markdown guide is **valid only for the GitLab internal Markdown rendering system for entries and files**. It is **not** valid for the [GitLab documentation website](https://docs.gitlab.com) -or [GitLab's main website](https://about.gitlab.com), as they both use +or the [GitLab main website](https://about.gitlab.com), as they both use [Kramdown](https://kramdown.gettalong.org) as their Markdown engine. The documentation website uses an extended Kramdown gem, [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown). Consult the [GitLab Kramdown Guide](https://about.gitlab.com/handbook/markdown-guide/) @@ -52,7 +52,7 @@ The documentation website had its [Markdown engine migrated from Redcarpet to Kr in October 2018. You may have older issues, merge requests, or Markdown documents in your -repository that were written using some of the nuances of GitLab's RedCarpet version +repository that were written using some of the nuances of the GitLab RedCarpet version of Markdown. Since CommonMark uses slightly stricter syntax, these documents might now appear a little differently since we have transitioned to CommonMark. @@ -353,7 +353,7 @@ The wrapping tags can be either curly braces or square brackets: - [- deletion 4 -] ``` -![Inline diff as rendered by GitLab's interface](img/inline_diff_01_v13_3.png) +![Inline diff as rendered by the GitLab interface](img/inline_diff_01_v13_3.png) --- @@ -375,7 +375,7 @@ backslash `\`, otherwise the diff highlight don't render correctly: - {+ Text with escaped \`backticks\` inside +} ``` -![Inline diff with mixed formatting, as rendered by GitLab's interface](img/inline_diff_02_v13_3.png) +![Inline diff with mixed formatting, as rendered by the GitLab interface](img/inline_diff_02_v13_3.png) ### Math @@ -480,7 +480,7 @@ unordered or ordered lists: 1. [x] Sub-task 2 ``` -![A task list as rendered by GitLab's interface](img/completed_tasks_v13_3.png) +![A task list as rendered by the GitLab interface](img/completed_tasks_v13_3.png) ### Table of contents @@ -1056,7 +1056,7 @@ are separated into their own lines: ``` <!-- -Note: The example below uses HTML to force correct rendering on docs.gitlab.com, +The example below uses HTML to force correct rendering on docs.gitlab.com, Markdown is fine in GitLab. --> |