PRO-100-1: GFM (GitHub Flavored Markdown)

[Ripppe]

Description Learn how to use GitHub Flavored Markdown in the descriptions of issues.

Information Comments and descriptions are parsed with GitHub Flavored Markdown. It's basically a normal markdown (http://daringfireball.net/projects/markdown/syntax) enhanced with some nice features, like task lists (https://help.github.com/articles/github-flavored-markdown). Generally it's a good practice to keep the formatting at the minimum and put more emphasis on the content itself, but here is a quick recap of the ones I encourage to use:

**Double asterisks make a bolded pharse**

Double asterisks make a bolded pharse I personally think that in descriptions, bolding should be used instead of proper headings (achieved with hash tags). Down below is a small representation of size of different headings:

# This is h1 level headline
### This is h3 level headline
###### This is h6 level headline
**This is "headline" with bolding**

This is h1 level headline

This is h3 level headline

This is h6 level headline

This is "headline" with bolding

This is a code block

```JavaScript
function() {
console.log("This is syntax highlighted code block");
}

This is a code block

``` JavaScript
function() {
console.log("This is syntax highlighted code block");
}

Here is a task list:
- [ ] Empty item
- [x] Checked item
- [ ] Of course the checking works just by pressing the checkboxes!

Here is a task list:

• [ ] Empty item
• [x] Checked item
• [ ] Of course the checking works just by pressing the checkboxes!

Normal lists:
* item1
* item2
* item3
and ordered lists:
1. item1
2. item2
3. item3

Normal lists:

• item1
• item2
• item3

and ordered lists:

1. item1
2. item2
3. item3

Two important notations are referencing an another existing issue and mentioning someone:

#2 -> This would make a link to a issue number 2
@Ripppe -> Would make a link that leads to me. It also becomes as a filter for the person mentioned.

2 -> This would make a link to a issue number 2

@Ripppe -> Would make a link that leads to me. It also becomes as a filter for the person mentioned.

Finally a nice touch with links (basic URLs are by default linked):

Here is some text where we want to implement link. The text of the link will be what you wrote inside the first square brackets! Here's one with the longer text!.

This will also act as a lesson that descriptions can be long!

References

• 5 - Main task

[HAVANA89]

I need this link to be created for my use as well