@@ -328,7 +290,7 @@ You can add task lists to issues, merge requests and comments. To create a task
...
@@ -328,7 +290,7 @@ You can add task lists to issues, merge requests and comments. To create a task
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.
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.
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
======
Alt-H2
------
### Header IDs and links
### Header IDs and links
All Markdown-rendered headers automatically get IDs, except in comments.
All Markdown-rendered headers automatically get IDs, except in comments.
...
@@ -416,7 +363,7 @@ Would generate the following link IDs:
...
@@ -416,7 +363,7 @@ Would generate the following link IDs:
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.
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.
## Emphasis
### Emphasis
```no-highlight
```no-highlight
Emphasis, aka italics, with *asterisks* or _underscores_.
Emphasis, aka italics, with *asterisks* or _underscores_.
...
@@ -436,7 +383,7 @@ Combined emphasis with **asterisks and _underscores_**.
...
@@ -436,7 +383,7 @@ Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
Strikethrough uses two tildes. ~~Scratch this.~~
## Lists
### Lists
```no-highlight
```no-highlight
1. First ordered list item
1. First ordered list item
...
@@ -492,7 +439,7 @@ the second list item will be incorrectly labeled as `1`.
...
@@ -492,7 +439,7 @@ the second list item will be incorrectly labeled as `1`.
Second paragraph of first item.
Second paragraph of first item.
2. Another item
2. Another item
## Links
### Links
There are two ways to create links, inline-style and reference-style.
There are two ways to create links, inline-style and reference-style.
...
@@ -501,9 +448,9 @@ There are two ways to create links, inline-style and reference-style.
...
@@ -501,9 +448,9 @@ There are two ways to create links, inline-style and reference-style.
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[I'm a relative reference to a repository file](LICENSE)
[I'm a relative reference to a repository file](LICENSE)
[I am an absolute reference within the repository](/doc/user/markdown.md)
[I am an absolute reference within the repository](/doc/user/markdown.md)
[I link to the Milestones page](/../milestones)
[I link to the Milestones page](/../milestones)
[You can use numbers for reference-style link definitions][1]
[You can use numbers for reference-style link definitions][1]
...
@@ -523,9 +470,9 @@ There are two ways to create links, inline-style and reference-style.
...
@@ -523,9 +470,9 @@ There are two ways to create links, inline-style and reference-style.
[I'm a relative reference to a repository file](LICENSE)[^1]
[I'm a relative reference to a repository file](LICENSE)[^1]
[I am an absolute reference within the repository](/doc/user/markdown.md)
[I am an absolute reference within the repository](/doc/user/markdown.md)
[I link to the Milestones page](/../milestones)
[I link to the Milestones page](/../milestones)
[You can use numbers for reference-style link definitions][1]
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself][]
Or leave it empty and use the [link text itself][]
...
@@ -544,7 +491,8 @@ Relative links do not allow referencing project files in a wiki page or wiki pag
...
@@ -544,7 +491,8 @@ Relative links do not allow referencing project files in a wiki page or wiki pag
will point the link to `wikis/style` when the link is inside of a wiki markdown file.
will point the link to `wikis/style` when the link is inside of a wiki markdown file.
## Images
### Images
Here's our logo (hover to see the title text):
Here's our logo (hover to see the title text):
...
@@ -568,7 +516,7 @@ Reference-style:
...
@@ -568,7 +516,7 @@ Reference-style:
[logo]: img/markdown_logo.png
[logo]: img/markdown_logo.png
## Blockquotes
### Blockquotes
```no-highlight
```no-highlight
> Blockquotes are very handy in email to emulate reply text.
> Blockquotes are very handy in email to emulate reply text.
...
@@ -586,7 +534,7 @@ Quote break.
...
@@ -586,7 +534,7 @@ 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* **Markdown** into a blockquote.
> 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.
## Inline HTML
### Inline HTML
You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
...
@@ -610,7 +558,7 @@ See the documentation for HTML::Pipeline's [SanitizationFilter](http://www.rubyd
...
@@ -610,7 +558,7 @@ See the documentation for HTML::Pipeline's [SanitizationFilter](http://www.rubyd
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>
</dl>
## Horizontal Rule
### Horizontal Rule
```
```
Three or more...
Three or more...
...
@@ -642,7 +590,7 @@ ___
...
@@ -642,7 +590,7 @@ ___
Underscores
Underscores
## Line Breaks
### Line Breaks
My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> 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.
My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> 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.
...
@@ -672,7 +620,7 @@ This line is also a separate paragraph, and...
...
@@ -672,7 +620,7 @@ This line is also a separate paragraph, and...
This line is on its own line, because the previous line ends with two
This line is on its own line, because the previous line ends with two
spaces.
spaces.
## Tables
### Tables
Tables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them.
Tables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them.
...
@@ -708,16 +656,15 @@ By including colons in the header row, you can align the text within that column
...
@@ -708,16 +656,15 @@ By including colons in the header row, you can align the text within that column
You can add footnotes to your text as follows.[^1]
[^1]: This is my awesome footnote.
```
```
You can add footnotes to your text as follows.[^1]
You can add footnotes to your text as follows.[^2]
[^1]:This is my awesome footnote.
[^2]:This is my awesome footnote.
```
```
You can add footnotes to your text as follows.[^2]
## Wiki-specific Markdown
## Wiki-specific Markdown
The following examples show how links inside wikis behave.
The following examples show how links inside wikis behave.
...
@@ -752,30 +699,30 @@ A link can be constructed relative to the current wiki page using `./<page>`,
...
@@ -752,30 +699,30 @@ A link can be constructed relative to the current wiki page using `./<page>`,
- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
it would link to `<your_wiki>/documentation/related`:
it would link to `<your_wiki>/documentation/related`:
```markdown
```markdown
[Link to Related Page](./related)
[Link to Related Page](./related)
```
```
- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
it would link to `<your_wiki>/documentation/main`:
it would link to `<your_wiki>/documentation/main`:
```markdown
```markdown
[Link to Related Page](../main)
[Link to Related Page](../main)
```
```
- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
- If this snippet was placed on a page at `<your_wiki>/documentation/main`,
it would link to `<your_wiki>/documentation/related.md`:
it would link to `<your_wiki>/documentation/related.md`:
```markdown
```markdown
[Link to Related Page](./related.md)
[Link to Related Page](./related.md)
```
```
- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
- If this snippet was placed on a page at `<your_wiki>/documentation/related/content`,
it would link to `<your_wiki>/documentation/main.md`:
it would link to `<your_wiki>/documentation/main.md`:
```markdown
```markdown
[Link to Related Page](../main.md)
[Link to Related Page](../main.md)
```
```
### Wiki - Root link
### Wiki - Root link
...
@@ -783,22 +730,25 @@ A link starting with a `/` is relative to the wiki root.
...
@@ -783,22 +730,25 @@ A link starting with a `/` is relative to the wiki root.
- This snippet links to `<wiki_root>/documentation`:
- This snippet links to `<wiki_root>/documentation`:
```markdown
```markdown
[Link to Related Page](/documentation)
[Link to Related Page](/documentation)
```
```
- This snippet links to `<wiki_root>/miscellaneous.md`:
- This snippet links to `<wiki_root>/miscellaneous.md`:
```markdown
```markdown
[Link to Related Page](/miscellaneous.md)
[Link to Related Page](/miscellaneous.md)
```
```
## References
## References
- This document leveraged heavily from the [Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
- This document leveraged heavily from the [Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
- The [Markdown Syntax Guide](https://daringfireball.net/projects/markdown/syntax) at Daring Fireball is an excellent resource for a detailed explanation of standard markdown.
- The [Markdown Syntax Guide](https://daringfireball.net/projects/markdown/syntax) at Daring Fireball is an excellent resource for a detailed explanation of standard markdown.
- [Dillinger.io](http://dillinger.io) is a handy tool for testing standard markdown.
- [Dillinger.io](http://dillinger.io) is a handy tool for testing standard markdown.
[^1]: This link will be broken if you see this document from the Help page or docs.gitlab.com
