Show Menu
Cheatography
  1. Home >
  2. Cheat Sheets >

GitLab Markdown Cheat Sheet (DRAFT) by

This is a draft cheat sheet. It is a work in progress and is not finished yet.

Special References

@user_name
specific user
 
@group­_name
specific group
 
@all
entire team
 
#123
issue
 
!123
merge request
 
$123
snippet
 
&123
epic
 
~123
label by ID
 
~bug
one-word label by name
 
~"fe­ature reques­t"
multi-word label by name
 
%123
project milestone by ID
 
%v1.23
one-word milestone by name
 
%"re­lease candid­ate­"
multi-word milestone by name
 
9ba12248
specific commit
 
9ba122­48...b­19a04f5
commit range comparison
repository file references
repository file line references

Cross-­Project References

ns/pro­jec­t#123
issue
 
ns/pro­jec­t!123
merge request
 
ns/pro­jec­t%123
project milestone
 
ns/pro­jec­t$123
snippet
 
ns/pro­jec­t@9­ba12248
specific commit
 
group1­/su­bgr­oup­&123
epic
 
ns/pro­jec­t@9­ba1­224­8...b1­9a04f5
commit range comparison
 
ns/pro­jec­t~"Some label"
issues with given label

Shorthand Cross-­Project References

projec­t#123
issue
 
projec­t!123
merge request
 
projec­t%123
project milestone
 
projec­t$123
snippet
 
projec­t@9­ba12248
specific commit
 
projec­t@9­ba1­224­8...b1­9a04f5
commit range comparison
 
projec­t~"Some label"
issues with given label
For projects from the same namespace.
  

Syntax Highli­ghting

```clojure
(def xf (comp (filter odd?) (map inc)))
```

Inline Diff

- {+ additions +}
- [+ additions +]
- {- deletions -}
- [- deletions -]
With inline diffs you can display {+ additions +} or [- deletions -].

Unordered Task Lists

- [x] Completed task
- [ ] Incomplete task
    - [ ] Sub-task 1
    - [x] Sub-task 2
    - [ ] Sub-task 3
You can add task lists to issues, merge requests and comments.

Ordered Task Lists

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

Videos

!Sample Video
Image tags with a video extension are automa­tically converted to a video player.

The valid video extensions are .mp4, .m4v, .mov, .webm, and .ogv.

Math with KaTeX

This math is inline $`a^2+b^2=c^2`$.

This is on a separate line
```math
a^2+b^2=c^2
```

Diagrams & Flowcharts

```mermaid
graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;
```
Refer to the Mermaid Cheat Sheet.

Headers

# H1
## H2
### H3
#### H4
##### H5
###### H6

Alternatively, for H1 and H2, an underline-ish style:

Alt-H1
======

Alt-H2
------

Header IDs & Links

All headers automa­tically get IDs, except in comments.

IDs are generated from header content as follows:

1. All text is converted to lowercase
2. All non-word text is removed
3. All spaces are converted to hyphens
4. Two or more hyphens in a row are converted to one
5. Emojis are removed
6. Duplicate headers have a unique increm­enting number appended.

Emphasis

Emphasis, aka italics, with *asterisks* or _underscores_.

Strong emphasis, aka bold, with **asterisks** or __underscores__.

Combined emphasis with **asterisks and _underscores_**.

Strikethrough uses two tildes. ~~Scratch this.~~