markdown.md 16.6 KB
Newer Older
1 2
# Markdown

3
## Table of Contents
4

5 6
**[GitLab Flavored Markdown](#gitlab-flavored-markdown-gfm)**

7 8
* [Newlines](#newlines)
* [Multiple underscores in words](#multiple-underscores-in-words)
9
* [URL auto-linking](#url-auto-linking)
10 11 12
* [Code and Syntax Highlighting](#code-and-syntax-highlighting)
* [Emoji](#emoji)
* [Special GitLab references](#special-gitlab-references)
13
* [Task lists](#task-lists)
14 15 16

**[Standard Markdown](#standard-markdown)**

17 18 19 20 21 22 23 24 25 26
* [Headers](#headers)
* [Emphasis](#emphasis)
* [Lists](#lists)
* [Links](#links)
* [Images](#images)
* [Blockquotes](#blockquotes)
* [Inline HTML](#inline-html)
* [Horizontal Rule](#horizontal-rule)
* [Line Breaks](#line-breaks)
* [Tables](#tables)
27 28

**[References](#references)**
29

30
## GitLab Flavored Markdown (GFM)
31

32
_GitLab uses the [Redcarpet Ruby library][redcarpet] for Markdown processing._
33

34
For GitLab uses "GitLab Flavored Markdown" (GFM). It extends the standard Markdown in a few significant ways to add some useful functionality. It was inspired by [GitHub Flavored Markdown](https://help.github.com/articles/basic-writing-and-formatting-syntax/).
35 36 37

You can use GFM in

38 39 40 41 42
- comments
- issues
- merge requests
- milestones
- wiki pages
43

44
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](https://github.com/gitlabhq/markup#markups) for more information.
45 46

## Newlines
47

48
GFM honors the markdown specification in how [paragraphs and line breaks are handled](https://daringfireball.net/projects/markdown/syntax#p).
49

50
A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines.
51
Line-breaks, or softreturns, are rendered if you end a line with two or more spaces
52

53
    Roses are red [followed by two or more spaces]
54 55
    Violets are blue

56 57
    Sugar is sweet

58
Roses are red
59
Violets are blue
60

61 62
Sugar is sweet

63 64
## Multiple underscores in words

65 66 67 68 69
It is not reasonable to italicize just _part_ of a word, especially when you're dealing with code and names that often appear with multiple underscores. Therefore, GFM ignores multiple underscores in words.

    perform_complicated_task
    do_this_and_do_that_and_another_thing

70
perform_complicated_task
71 72
do_this_and_do_that_and_another_thing

73
## URL auto-linking
74

75 76
GFM will autolink almost any URL you copy and paste into your text.

77
    * https://www.google.com
78 79 80 81 82 83
    * https://google.com/
    * ftp://ftp.us.debian.org/debian/
    * smb://foo/bar/baz
    * irc://irc.freenode.net/gitlab
    * http://localhost:3000

84
* https://www.google.com
85 86 87 88 89
* https://google.com/
* ftp://ftp.us.debian.org/debian/
* smb://foo/bar/baz
* irc://irc.freenode.net/gitlab
* http://localhost:3000
90 91 92

## Code and Syntax Highlighting

93 94
_GitLab uses the [Rouge Ruby library][rouge] for syntax highlighting. For a
list of supported languages visit the Rouge website._
95

96 97 98 99 100 101 102 103 104 105 106 107 108 109
Blocks of code are either fenced by lines with three back-ticks <code>```</code>, or are indented with four spaces. Only the fenced code blocks support syntax highlighting.

```no-highlight
Inline `code` has `back-ticks around` it.
```

Inline `code` has `back-ticks around` it.

Example:

    ```javascript
    var s = "JavaScript syntax highlighting";
    alert(s);
    ```
110

111 112 113 114 115 116
    ```python
    def function():
        #indenting works just fine in the fenced code block
        s = "Python syntax highlighting"
        print s
    ```
117

118 119 120 121 122 123 124
    ```ruby
    require 'redcarpet'
    markdown = Redcarpet.new("Hello World!")
    puts markdown.to_html
    ```

    ```
125
    No language indicated, so no syntax highlighting.
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    s = "There is no highlighting for this."
    But let's throw in a <b>tag</b>.
    ```

becomes:

```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```

```python
def function():
    #indenting works just fine in the fenced code block
    s = "Python syntax highlighting"
    print s
```

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```

```
No language indicated, so no syntax highlighting.
s = "There is no highlighting for this."
But let's throw in a <b>tag</b>.
```

156
## Emoji
157

158
	Sometimes you want to :monkey: around a bit and add some :star2: to your :speech_balloon:. Well we have a gift for you:
159

160
	:zap: You can use emoji anywhere GFM is supported. :v:
161

162
	You can use it to point out a :bug: or warn about :speak_no_evil: patches. And if someone improves your really :snail: code, send them some :birthday:. People will :heart: you for that.
163

164
	If you are new to this, don't be :fearful:. You can easily join the emoji :family:. All you need to do is to look up on the supported codes.
165

166
	Consult the [Emoji Cheat Sheet](http://emoji.codes) for a list of all supported emoji codes. :thumbsup:
167

168
Sometimes you want to :monkey: around a bit and add some :star2: to your :speech_balloon:. Well we have a gift for you:
169

170
:zap: You can use emoji anywhere GFM is supported. :v:
171

172
You can use it to point out a :bug: or warn about :speak_no_evil: patches. And if someone improves your really :snail: code, send them some :birthday:. People will :heart: you for that.
173

174
If you are new to this, don't be :fearful:. You can easily join the emoji :family:. All you need to do is to look up on the supported codes.
175

176
Consult the [Emoji Cheat Sheet](http://emoji.codes) for a list of all supported emoji codes. :thumbsup:
177

178
## Special GitLab References
179

180
GFM recognizes special references.
181

182
You can easily reference e.g. an issue, a commit, a team member or even the whole team within a project.
183

184 185 186 187
GFM will turn that reference into a link so you can navigate between them easily.

GFM will recognize the following:

188
| input                  | references                 |
189
|:-----------------------|:---------------------------|
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
| `@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     |
| `~"feature request"`   | multi-word label by name   |
| `9ba12248`             | specific commit            |
| `9ba12248...b19a04f5`  | commit range comparison    |
| `[README](doc/README)` | repository file references |

GFM also recognizes certain cross-project references:

| input                                   | references              |
206
|:----------------------------------------|:------------------------|
207 208 209 210 211
| `namespace/project#123`                 | issue                   |
| `namespace/project!123`                 | merge request           |
| `namespace/project$123`                 | snippet                 |
| `namespace/project@9ba12248`            | specific commit         |
| `namespace/project@9ba12248...b19a04f5` | commit range comparison |
212
| `namespace/project~"Some label"`        | issues with given label |
213

214 215
## Task Lists

216
You can add task lists to issues, merge requests and comments. To create a task list, add a specially-formatted Markdown list, like so:
217 218

```no-highlight
219 220 221 222 223
- [x] Completed task
- [ ] Incomplete task
    - [ ] Sub-task 1
    - [x] Sub-task 2
    - [ ] Sub-task 3
224 225
```

226 227 228 229 230 231 232
- [x] Completed task
- [ ] Incomplete task
    - [ ] Sub-task 1
    - [x] Sub-task 2
    - [ ] Sub-task 3

Task lists can only be created in descriptions, not in titles. Task item state can be managed by editing the description's Markdown or by toggling the rendered check boxes.
233

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
# Standard Markdown

## Headers

```no-highlight
# H1
## H2
### H3
#### H4
##### H5
###### H6

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

Alt-H1
======

Alt-H2
------
```

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

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

Alt-H1
======

Alt-H2
------

270 271
### Header IDs and links

272
All Markdown-rendered headers automatically get IDs, except in comments.
273 274 275 276 277

On hover a link to those IDs becomes visible to make it easier to copy the link to the header to give it to someone else.

The IDs are generated from the content of the header according to the following rules:

278 279 280 281 282
1. All text is converted to lowercase
1. All non-word text (e.g., punctuation, HTML) is removed
1. All spaces are converted to hyphens
1. Two or more hyphens in a row are converted to one
1. If a header with the same ID has already been generated, a unique
283
   incrementing number is appended, starting at 1.
284 285 286 287

For example:

```
288 289 290 291 292
# This header has spaces in it
## This header has a :thumbsup: in it
# This header has Unicode in it: 한글
## This header has spaces in it
### This header has spaces in it
293 294
```

295
Would generate the following link IDs:
296

297 298 299
1. `this-header-has-spaces-in-it`
1. `this-header-has-a-in-it`
1. `this-header-has-unicode-in-it-한글`
300
1. `this-header-has-spaces-in-it`
301
1. `this-header-has-spaces-in-it-1`
302

303
Note that the Emoji processing happens before the header IDs are generated, so the Emoji is converted to an image which then gets removed from the ID.
304

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
## Emphasis

```no-highlight
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.~~
```

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.~~

## Lists

```no-highlight
1. First ordered list item
2. Another item
330
  * Unordered sub-list.
331 332
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
333 334
4. And another item.

335 336 337 338 339 340 341
* Unordered list can use asterisks
- Or minuses
+ Or pluses
```

1. First ordered list item
2. Another item
342
  * Unordered sub-list.
343 344
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
345 346
4. And another item.

347 348 349 350
* Unordered list can use asterisks
- Or minuses
+ Or pluses

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
If a list item contains multiple paragraphs,
each subsequent paragraph should be indented with four spaces.

```no-highlight
1.  First ordered list item

    Second paragraph of first item.
2.  Another item
```

1.  First ordered list item

    Second paragraph of first item.
2.  Another item

If the second paragraph isn't indented with four spaces,
the second list item will be incorrectly labeled as `1`.

```no-highlight
1. First ordered list item

   Second paragraph of first item.
2. Another item
```

1. First ordered list item

   Second paragraph of first item.
2. Another item

381 382
## Links

383
There are two ways to create links, inline-style and reference-style.
384 385 386 387 388

    [I'm an inline-style link](https://www.google.com)

    [I'm a reference-style link][Arbitrary case-insensitive reference text]

389
    [I'm a relative reference to a repository file](LICENSE)
390 391 392 393 394 395 396 397 398

    [You can use numbers for reference-style link definitions][1]

    Or leave it empty and use the [link text itself][]

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

    [arbitrary case-insensitive reference text]: https://www.mozilla.org
    [1]: http://slashdot.org
399
    [link text itself]: https://www.reddit.com
400 401 402 403 404

[I'm an inline-style link](https://www.google.com)

[I'm a reference-style link][Arbitrary case-insensitive reference text]

405
[I'm a relative reference to a repository file](LICENSE)
406 407 408 409 410 411 412 413 414

[You can use numbers for reference-style link definitions][1]

Or leave it empty and use the [link text itself][]

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

[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
415
[link text itself]: https://www.reddit.com
416

417 418
**Note**

419
Relative links do not allow referencing project files in a wiki page or wiki page in a project file. The reason for this is that, in GitLab, wiki is always a separate git repository. For example:
420

421
`[I'm a reference-style link](style)`
422 423 424

will point the link to `wikis/style` when the link is inside of a wiki markdown file.

425 426 427 428
## Images

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

429
    Inline-style:
430
    ![alt text](img/logo.png)
431

432
    Reference-style:
433
    ![alt text1][logo]
434

435
    [logo]: img/logo.png
436

437
Here's our logo:
438

439
Inline-style:
440

441
![alt text](img/logo.png)
442

443
Reference-style:
444

445 446
![alt text][logo]

447
[logo]: img/logo.png
448 449 450 451 452 453 454 455 456

## Blockquotes

```no-highlight
> Blockquotes are very handy in email to emulate reply text.
> This line is part of the same quote.

Quote break.

457
> 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* **Markdown** into a blockquote.
458 459 460 461 462 463 464
```

> Blockquotes are very handy in email to emulate reply text.
> This line is part of the same quote.

Quote break.

465
> 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* **Markdown** into a blockquote.
466 467 468

## Inline HTML

469
You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
470

471
See the documentation for HTML::Pipeline's [SanitizationFilter](http://www.rubydoc.info/gems/html-pipeline/HTML/Pipeline/SanitizationFilter#WHITELIST-constant) class for the list of allowed HTML tags and attributes.  In addition to the default `SanitizationFilter` whitelist, GitLab allows `span` elements.
472

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
```no-highlight
<dl>
  <dt>Definition list</dt>
  <dd>Is something people use sometimes.</dd>

  <dt>Markdown in HTML</dt>
  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>
```

<dl>
  <dt>Definition list</dt>
  <dd>Is something people use sometimes.</dd>

  <dt>Markdown in HTML</dt>
  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>

## Horizontal Rule

```
Three or more...

---

Hyphens

***

Asterisks

___

Underscores
```

Three or more...

---

Hyphens

***

Asterisks

___

Underscores

## Line Breaks

525
My basic recommendation for learning how line breaks work is to experiment and discover -- hit &lt;Enter&gt; once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what happens. You'll soon learn to get what you want. "Markdown Toggle" is your friend.
526 527 528 529 530 531 532 533 534 535

Here are some things to try out:

```
Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a *separate paragraph*.

This line is also a separate paragraph, but...
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.
536

537
This line is also a separate paragraph, and...
538 539
This line is on its own line, because the previous line ends with two
spaces.
540 541 542 543 544 545
```

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a *separate paragraph*.

546
This line is also begins a separate paragraph, but...
547 548
This line is only separated by a single newline, so it's a separate line in the *same paragraph*.

549
This line is also a separate paragraph, and...
550 551 552
This line is on its own line, because the previous line ends with two
spaces.

553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
## Tables

Tables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them.

```
| header 1 | header 2 |
| -------- | -------- |
| cell 1   | cell 2   |
| cell 3   | cell 4   |
```

Code above produces next output:

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

571 572 573 574
**Note**

The row of dashes between the table header and body must have at least three dashes in each column.

575 576 577 578 579 580 581 582 583 584 585 586 587 588
By including colons in the header row, you can align the text within that column:

```
| Left Aligned | Centered | Right Aligned | Left Aligned | Centered | Right Aligned |
| :----------- | :------: | ------------: | :----------- | :------: | ------------: |
| Cell 1       | Cell 2   | Cell 3        | Cell 4       | Cell 5   | Cell 6        |
| Cell 7       | Cell 8   | Cell 9        | Cell 10      | Cell 11  | Cell 12       |
```

| Left Aligned | Centered | Right Aligned | Left Aligned | Centered | Right Aligned |
| :----------- | :------: | ------------: | :----------- | :------: | ------------: |
| Cell 1       | Cell 2   | Cell 3        | Cell 4       | Cell 5   | Cell 6        |
| Cell 7       | Cell 8   | Cell 9        | Cell 10      | Cell 11  | Cell 12       |

589 590
## References

591
- This document leveraged heavily from the [Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
592
- The [Markdown Syntax Guide](https://daringfireball.net/projects/markdown/syntax) at Daring Fireball is an excellent resource for a detailed explanation of standard markdown.
593
- [Dillinger.io](http://dillinger.io) is a handy tool for testing standard markdown.
594 595

[rouge]: http://rouge.jneen.net/ "Rouge website"
596
[redcarpet]: https://github.com/vmg/redcarpet "Redcarpet website"