BigW Consortium Gitlab

markdown.md 22.9 KB
Newer Older
1 2
# Markdown

3
## GitLab Flavored Markdown (GFM)
4

5 6 7 8 9 10 11
> **Note:**
Not all of the GitLab-specific extensions to Markdown that are described in
this document currently work on our documentation website.
>
For the best result, we encourage you to check this document out as rendered
by GitLab: [markdown.md]

12
_GitLab uses the [Redcarpet Ruby library][redcarpet] for Markdown processing._
13

14
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/).
15

16
You can use GFM in the following areas:
17

18 19 20 21
- comments
- issues
- merge requests
- milestones
22
- snippets (the snippet must be named with a `.md` extension)
23
- wiki pages
24
- markdown documents inside the repository
25

26 27
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.
28

29
### Newlines
30

31
> If this is not rendered correctly, see
32
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#newlines
33

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

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

39
    Roses are red [followed by two or more spaces]
40 41
    Violets are blue

42 43
    Sugar is sweet

44
Roses are red  
45
Violets are blue
46

47 48
Sugar is sweet

49
### Multiple underscores in words
50

51
> If this is not rendered correctly, see
52
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#multiple-underscores-in-words
53 54

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:
55 56

    perform_complicated_task
57

58 59
    do_this_and_do_that_and_another_thing

60
perform_complicated_task
61

62 63
do_this_and_do_that_and_another_thing

64
### URL auto-linking
65

66
> If this is not rendered correctly, see
67
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#url-auto-linking
68 69

GFM will autolink almost any URL you copy and paste into your text:
70

71
    * https://www.google.com
72 73 74 75 76 77
    * https://google.com/
    * ftp://ftp.us.debian.org/debian/
    * smb://foo/bar/baz
    * irc://irc.freenode.net/gitlab
    * http://localhost:3000

78
* https://www.google.com
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

85
### Multiline Blockquote
86

87
> If this is not rendered correctly, see
88
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#multiline-blockquote
89

90
On top of standard Markdown [blockquotes](#blockquotes), which require prepending `>` to quoted lines,
91
GFM supports multiline blockquotes fenced by <code>>>></code>:
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

```no-highlight
>>>
If you paste a message from somewhere else

that

spans

multiple lines,

you can quote that without having to manually prepend `>` to every line!
>>>
```

>>>
If you paste a message from somewhere else

that

spans

multiple lines,

you can quote that without having to manually prepend `>` to every line!
>>>

119
### Code and Syntax Highlighting
120

121
> If this is not rendered correctly, see
122
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#code-and-syntax-highlighting
123

124 125
_GitLab uses the [Rouge Ruby library][rouge] for syntax highlighting. For a
list of supported languages visit the Rouge website._
126

127 128 129
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:
130 131 132 133 134 135 136 137 138 139 140 141 142

```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);
    ```
143

144 145 146 147 148 149
    ```python
    def function():
        #indenting works just fine in the fenced code block
        s = "Python syntax highlighting"
        print s
    ```
150

151 152 153 154 155 156 157
    ```ruby
    require 'redcarpet'
    markdown = Redcarpet.new("Hello World!")
    puts markdown.to_html
    ```

    ```
158
    No language indicated, so no syntax highlighting.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
    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>.
```

189
### Inline Diff
190

191
> If this is not rendered correctly, see
192
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#inline-diff
193

194 195 196 197 198 199 200 201 202 203 204
With inline diffs tags you can display {+ additions +} or [- deletions -].

The wrapping tags can be either curly braces or square brackets [+ additions +] or {- deletions -}.

However the wrapping tags cannot be mixed as such:

- {+ additions +]
- [+ additions +}
- {- deletions -]
- [- deletions -}

205
### Emoji
206

207
> If this is not rendered correctly, see
208
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#emoji
209

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

212
	:zap: You can use emoji anywhere GFM is supported. :v:
213

214
	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.
215

216
	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.
217

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

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

222
:zap: You can use emoji anywhere GFM is supported. :v:
223

224
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.
225

226
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.
227

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

230
### Special GitLab References
231

232
GFM recognizes special references.
233

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

236 237 238 239
GFM will turn that reference into a link so you can navigate between them easily.

GFM will recognize the following:

240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
| input                  | 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       |
| `~"feature request"`   | multi-word label by name     |
| `%123`                 | milestone by ID              |
| `%v1.23`               | one-word milestone by name   |
| `%"release candidate"` | multi-word milestone by name |
| `9ba12248`             | specific commit              |
| `9ba12248...b19a04f5`  | commit range comparison      |
| `[README](doc/README)` | repository file references   |
257 258 259 260

GFM also recognizes certain cross-project references:

| input                                   | references              |
261
|:----------------------------------------|:------------------------|
262 263
| `namespace/project#123`                 | issue                   |
| `namespace/project!123`                 | merge request           |
264
| `namespace/project%123`                 | milestone               |
265 266 267
| `namespace/project$123`                 | snippet                 |
| `namespace/project@9ba12248`            | specific commit         |
| `namespace/project@9ba12248...b19a04f5` | commit range comparison |
268
| `namespace/project~"Some label"`        | issues with given label |
269

270 271 272 273 274 275 276 277 278 279 280 281
It also has a shorthand version to reference other projects from the same namespace:

| input                         | references              |
|:------------------------------|:------------------------|
| `project#123`                 | issue                   |
| `project!123`                 | merge request           |
| `project%123`                 | milestone               |
| `project$123`                 | snippet                 |
| `project@9ba12248`            | specific commit         |
| `project@9ba12248...b19a04f5` | commit range comparison |
| `project~"Some label"`        | issues with given label |

282
### Task Lists
283

284
> If this is not rendered correctly, see
285
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#task-lists
286

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

```no-highlight
290 291 292 293 294
- [x] Completed task
- [ ] Incomplete task
    - [ ] Sub-task 1
    - [x] Sub-task 2
    - [ ] Sub-task 3
295 296
```

297 298 299 300 301 302 303
- [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.
304

305
### Videos
306

307
> If this is not rendered correctly, see
308
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#videos
309

310 311
Image tags with a video extension are automatically converted to a video player.

312
The valid video extensions are `.mp4`, `.m4v`, `.mov`, `.webm`, and `.ogv`.
313 314 315

    Here's a sample video:

316
    ![Sample Video](img/markdown_video.mp4)
317 318 319

Here's a sample video:

320
![Sample Video](img/markdown_video.mp4)
321

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
### Math

> If this is not rendered correctly, see
https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md#math

It is possible to have math written with the LaTeX syntax rendered using [KaTeX][katex].

Math written inside ```$``$``` will be rendered inline with the text.

Math written inside triple back quotes, with the language declared as `math`, will be rendered on a separate line.

Example:

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

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

Becomes:

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

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

_Be advised that KaTeX only supports a [subset][katex-subset] of LaTeX._

>**Note:**
This also works for the asciidoctor `:stem: latexmath`. For details see the [asciidoctor user manual][asciidoctor-manual].

356
## Standard Markdown
357

358
### Headers
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

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

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

Alt-H1
======

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

377 378
### Header IDs and links

379
All Markdown-rendered headers automatically get IDs, except in comments.
380 381 382 383 384

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:

385 386 387 388 389
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
390
   incrementing number is appended, starting at 1.
391 392 393 394

For example:

```
395 396 397 398 399
# 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
400 401
```

402
Would generate the following link IDs:
403

404 405 406
1. `this-header-has-spaces-in-it`
1. `this-header-has-a-in-it`
1. `this-header-has-unicode-in-it-한글`
407
1. `this-header-has-spaces-in-it`
408
1. `this-header-has-spaces-in-it-1`
409

410
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.
411

412
### Emphasis
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431

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

432
### Lists
433 434 435 436

```no-highlight
1. First ordered list item
2. Another item
437
  * Unordered sub-list.
438 439
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
440 441
4. And another item.

442 443 444 445 446 447 448
* Unordered list can use asterisks
- Or minuses
+ Or pluses
```

1. First ordered list item
2. Another item
449
  * Unordered sub-list.
450 451
1. Actual numbers don't matter, just that it's a number
  1. Ordered sub-list
452 453
4. And another item.

454 455 456 457
* Unordered list can use asterisks
- Or minuses
+ Or pluses

458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
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

488
### Links
489

490
There are two ways to create links, inline-style and reference-style.
491 492 493 494 495

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

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

496
    [I'm a relative reference to a repository file](LICENSE)
497

498
    [I am an absolute reference within the repository](/doc/user/markdown.md)
499

500
    [I link to the Milestones page](/../milestones)
501 502 503 504 505 506 507 508 509

    [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
510
    [link text itself]: https://www.reddit.com
511 512 513 514 515

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

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

516
[I'm a relative reference to a repository file](LICENSE)[^1]
517

518
[I am an absolute reference within the repository](/doc/user/markdown.md)
519

520
[I link to the Milestones page](/../milestones)
521

522 523 524 525 526 527 528 529
[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
530
[link text itself]: https://www.reddit.com
531

532 533
**Note**

534
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:
535

536
`[I'm a reference-style link](style)`
537 538 539

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

540 541

### Images
542 543 544

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

545
    Inline-style:
546
    ![alt text](img/markdown_logo.png)
547

548
    Reference-style:
549
    ![alt text1][logo]
550

551
    [logo]: img/markdown_logo.png
552

553
Here's our logo:
554

555
Inline-style:
556

557
![alt text](img/markdown_logo.png)
558

559
Reference-style:
560

561 562
![alt text][logo]

563
[logo]: img/markdown_logo.png
564

565
### Blockquotes
566 567 568 569 570 571 572

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

Quote break.

573
> 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.
574 575 576 577 578 579 580
```

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

Quote break.

581
> 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.
582

583
### Inline HTML
584

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

587
See the documentation for HTML::Pipeline's [SanitizationFilter](http://www.rubydoc.info/gems/html-pipeline/1.11.0/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.
588

589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
```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>

607
### Horizontal Rule
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638

```
Three or more...

---

Hyphens

***

Asterisks

___

Underscores
```

Three or more...

---

Hyphens

***

Asterisks

___

Underscores

639
### Line Breaks
640

641
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.
642 643 644 645 646 647 648 649 650 651

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*.
652

653
This line is also a separate paragraph, and...  
654 655
This line is on its own line, because the previous line ends with two
spaces.
656 657 658 659 660 661
```

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

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

665
This line is also a separate paragraph, and...  
666 667 668
This line is on its own line, because the previous line ends with two
spaces.

669
### Tables
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686

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   |

687 688 689 690
**Note**

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

691 692 693 694 695 696 697 698 699 700 701 702 703 704
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       |

705
### Footnotes
706 707

```
708 709
You can add footnotes to your text as follows.[^2]
[^2]: This is my awesome footnote.
710
```
711

712 713
You can add footnotes to your text as follows.[^2]

714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
## Wiki-specific Markdown

The following examples show how links inside wikis behave.

### Wiki - Direct page link

A link which just includes the slug for a page will point to that page,
_at the base level of the wiki_.

This snippet would link to a `documentation` page at the root of your wiki:

```markdown
[Link to Documentation](documentation)
```

### Wiki - Direct file link

Links with a file extension point to that file, _relative to the current page_.

If this snippet was placed on a page at `<your_wiki>/documentation/related`,
it would link to `<your_wiki>/documentation/file.md`:

```markdown
[Link to File](file.md)
```

### Wiki - Hierarchical link

A link can be constructed relative to the current wiki page using `./<page>`,
`../<page>`, etc.

- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
  it would link to `<your_wiki>/documentation/related`:

748 749 750
    ```markdown
    [Link to Related Page](./related)
    ```
751 752 753 754

- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
  it would link to `<your_wiki>/documentation/main`:

755 756 757
    ```markdown
    [Link to Related Page](../main)
    ```
758 759 760 761

- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
  it would link to `<your_wiki>/documentation/related.md`:

762 763 764
    ```markdown
    [Link to Related Page](./related.md)
    ```
765 766 767 768

- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
  it would link to `<your_wiki>/documentation/main.md`:

769 770 771
    ```markdown
    [Link to Related Page](../main.md)
    ```
772 773 774 775 776 777 778

### Wiki - Root link

A link starting with a `/` is relative to the wiki root.

- This snippet links to `<wiki_root>/documentation`:

779 780 781
    ```markdown
    [Link to Related Page](/documentation)
    ```
782 783 784

- This snippet links to `<wiki_root>/miscellaneous.md`:

785 786 787 788
    ```markdown
    [Link to Related Page](/miscellaneous.md)
    ```

789 790
## References

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

795 796 797
[^1]: This link will be broken if you see this document from the Help page or docs.gitlab.com
[^2]: This is my awesome footnote.

798
[markdown.md]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/user/markdown.md
799
[rouge]: http://rouge.jneen.net/ "Rouge website"
800
[redcarpet]: https://github.com/vmg/redcarpet "Redcarpet website"
801 802 803
[katex]: https://github.com/Khan/KaTeX "KaTeX website"
[katex-subset]: https://github.com/Khan/KaTeX/wiki/Function-Support-in-KaTeX "Macros supported by KaTeX"
[asciidoctor-manual]: http://asciidoctor.org/docs/user-manual/#activating-stem-support "Asciidoctor user manual"