Show Menu

GitLab Markdown Cheat Sheet by

Quick references to the GitLab MD language
gitlab

Special GitLab References

@user_name
specific user
@group­_name
specific group
@all
entire team
#123
issue
!123
merge request
$123
snippet
~123
label by ID
~bug
one-word label by name
~"fe­ature reques­t"
multi-word label by name
9ba12248
specific commit
9ba122­48...b­19a04f5
commit range comparison
[READM­E](­doc­/RE­ADME)
repository file references

Other GitLab References

namesp­ace­/pr­oje­ct#123
issue
namesp­ace­/pr­oje­ct!123
merge request
namesp­ace­/pr­oje­ct$123
snippet
namesp­ace­/pr­oje­ct@­9ba­12248
specific commit
namesp­ace­/pr­oje­ct@­9ba­122­48...b­19a04f5
commit range comparison

Task Lists

You can add task lists to issues, merge requests and comments. To create a task list, add a specia­lly­-fo­rmatted Markdown list, like so:

- [x] Completed task
- [ ] Incomplete task
  - [ ] Sub-task 1
  - [x] Sub-task 2
  - [ ] Sub-task 3

Task lists can only be created in descri­ptions, not in titles. Task item state can be managed by editing the descri­ption's Markdown or by toggling the rendered check boxes.
 

Standard Markdown

Head­ers
# H1
## H2
### H3
#### H4
##### H5
###### H6

Altern­ati­vely, for H1 and H2, an underl­ine-ish style:

Alt-H1
======

Alt-H2
------

Emph­asis
Emphasis, aka italics, with *aste­risks* or _under­sco­res_.

Strong emphasis, aka bold, with **as­ter­isk­s** or __unde­rsc­ores__.

Combined emphasis with **as­terisks and _under­sco­res­_**.

Strike­through uses two tildes. ~~Sc­ratch this.~~

Lists
1. First ordered list item
2. Another item
 ­ * Unordered sub-list.
1. Actual numbers doesn't matter, just that it's a number
 ­ 1. Ordered sub-list
4. And another item.

* Unordered list can use asterisks
- Or minuses
+ Or pluses
 

Standard Markdown Cont

Links
There are two ways to create links, inline­-style and refere­nce­-style.

[inline link](­htt­ps:­//w­ww.g­oo­gle.com)
[reference link][­Arb­itrary reference text]
[relative reference to a repo file](­LIC­ENSE)
[numbers for reference link defini­tio­ns][1]
Or leave it empty [link text itself][]

Some text to show that the reference links can follow later.

[arbitrary reference text]: https­://­www.mo­zil­la.org
[1]: http:­//s­las­hdo­t.org
[link text itself]: http:­//w­ww.r­ed­dit.com

Images
Here's our logo (hover to see the title text):

Inline­-style:
![alt text](­ass­ets­/lo­go-­whi­te.png)

Refere­nce­-style:
![alt text1]­[logo]

[logo]: assets­/lo­go-­whi­te.png

Bloc­kqu­otes
> Blockq­uotes are very handy in email to emulate reply text.
> This line is part of the same quote.

Quote break.

> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Mark­down into a blockq­uote.

Tables
| header 1  | header 2  |
| -------- | -------- |
| cell 1  ­ ­ ­ ­  | cell 2  ­ ­ ­ ­ ­  |
| cell 3  ­ ­ ­ ­  | cell 4        |

| Left Aligned  ­ | Centered | Right Aligned   |
| :-----­------ | :------: | ------­------: |
| Cell 1  ­ ­ ­ ­ ­ ­ ­ ­ ­ ­  | Cell 2  ­ ­ ­  | Cell 3  ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ ­ |

Download the GitLab Markdown Cheat Sheet

1 Page
//media.cheatography.com/storage/thumb/snidd111_gitlab-markdown.750.jpg

PDF (recommended)

Alternative Downloads

Share This Cheat Sheet!

 

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          Related Cheat Sheets