GitHub flavored markdown is used to generate rich text and can be used in Issue, Pull Request, Readme.md, other .md files and at other places on GitHub where comments are required.
Sample Markdowns
View source to see how to generate the samples below
Emojis :grinning:
Strikethrough
this
Urls http://www.github.com/ Google
Reference "@riteshudhani"
Issue Reference #1
Tables
First Header | Second Header |
---|---|
Content from cell 1 | Content from cell 2 |
Content in the first column | Content in the second column |
Tasks
- @mentions, #refs, links, formatting, and
tagssupported - list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
Source Code
cout << "Hello World"
BlockQuotes As Kanye West said:
We're living the future so the present is our past.
Ordered Lists
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b
Unordered Lists
- Item 1
- Item 2
- Item 2a
- Item 2b
Bold Italic This text will be italic This will also be italic
This text will be bold This will also be bold
You can combine them
Headers
Bullets
- Bullet1
- Bullet2
Reference: https://guides.github.com/features/mastering-markdown/