Commit d15c9ae3 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs-dev-guidelines-update' into 'master'

Docs: updates docs development guidelines

Closes #53160 and #53115

See merge request gitlab-org/gitlab-ce!22813
parents f5e3ce5e 3cfdb0ac
This diff is collapsed.
This diff is collapsed.
# Markdown
# GitLab Markdown
This markdown guide is valid for GitLab's system markdown entries and files.
This markdown guide is **valid for GitLab's system markdown entries and files**.
It is not valid for the [GitLab documentation website](
nor [GitLab's main website](, as they both use
[Kramdown]( as their markdown engine.
The documentation website uses an extended Kramdown gem, [GitLab Kramdown](
Consult the [GitLab Kramdown Guide]( for a complete Kramdown reference._
## GitLab Flavored Markdown (GFM)
......@@ -8,21 +13,21 @@ GitLab uses "GitLab Flavored Markdown" (GFM). It extends the [CommonMark specifi
You can use GFM in the following areas:
- comments
- issues
- merge requests
- milestones
- snippets (the snippet must be named with a `.md` extension)
- wiki pages
- markdown documents inside the repository
- Comments
- Issues
- Merge requests
- Milestones
- Snippets (the snippet must be named with a `.md` extension)
- Wiki pages
- Markdown documents inside repositories
You can also use other rich text files in GitLab. You might have to install a
dependency to do so. Please see the [`github-markup` gem readme]( for more information.
> **Notes:**
> For the best result, we encourage you to check this document out as rendered
> by GitLab itself: []
> For the best result, we encourage you to check this document out as [rendered
> by GitLab itself](
> As of 11.1, GitLab uses the [CommonMark Ruby Library][commonmarker] for Markdown
processing of all new issues, merge requests, comments, and other Markdown content
......@@ -30,6 +35,9 @@ in the GitLab system. As of 11.3, wiki pages and Markdown files (`.md`) in the
repositories are also processed with CommonMark. Older content in issues/comments
are still processed using the [Redcarpet Ruby library][redcarpet].
> The documentation website had its [markdown engine migrated from Redcarpet to Kramdown](
in October 2018.
> _Where there are significant differences, we will try to call them out in this document._
### Transitioning to CommonMark
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment