Github Flavoured Markdown CheatSheet
The following markdown cheatsheet is adapted from: https://guides.github.com/features/mastering-markdown/
Adapted from: https://guides.github.com/features/mastering-markdown/
Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.
Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.
1# This is a h1 tag23## This is a h2 tag45#### This is a h4 tag
This is a h1 tag
This is a h4 tag
1_This text will be italic_23**This text will be bold**45_You **can** combine them_
This text will be italic
This text will be bold
You can combine them
Unordered
1- Item 12- Item 23- Item 2a4- Item 2b
- Item 1
- Item 2
- Item 2a
- Item 2b
Ordered
11. Item 121. Item 231. Item 341. Item 3a51. Item 3b
- Item 1
- Item 2
- Item 3
- Item 3a
- Item 3b

1http://github.com - automatic!2[GitHub](http://github.com)
http://github.com - automatic! GitHub
1As Kanye West said:23> We're living the future so4> the present is our past.
As Kanye West said:
We're living the future so the present is our past.
1I think you should use an2`<addr>` element here instead.
I think you should use an
<addr> element here instead.
Here’s an example of how you can use syntax highlighting with GitHub Flavored Markdown:
'fancyAlert.js'
1function fancyAlert(arg) {2if (arg) {3$.facebox({ div: '#foo' })4}5}
And here's how it looks - nicely colored with styled code titles!
Here is a simple footnote[^1]. With some additional text after it.
[^1]: My reference.
Here is a simple footnote1. With some additional text after it.
1- [x] list syntax required (any unordered or ordered list supported)2- [x] this is a complete item3- [ ] this is an incomplete item
- list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:
| First Header | Second Header |
| --------------------------- | ---------------------------- |
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
| First Header | Second Header |
|---|---|
| Content from cell 1 | Content from cell 2 |
| Content in the first column | Content in the second column |
Any word wrapped with two tildes (like ~~this~~) will appear crossed out.
-
My reference. ↩