Juicy lil' bytes

Markdown Cheat Sheet

I needed a quick and dirty reference for the Markdown syntax. Voila. The raw Markdown Cheat Sheet file (in GitHub flavored Markdown) is available on GitHub with a Creative Commons license.

Contents

Typography

Headings

Heading MarkdownGruber Docs
1
2
3
4
5
6
<h1> = # Header
<h2> = ## Header
<h3> = ### Header
<h4> = #### Header
<h5> = ##### Header
<h6> = ###### Header

Paragraphs

Paragraph MarkdownGruber Docs
1
2
3
This is the first paragraph.

And this is the second separated by a blank line.

Bold Text

Bold Text MarkdownGruber Docs
1
In this sentence the word **bold** is tagged with <strong> tags.

Italicized Text

Italicized TextGruber Docs
1
In this sentence the word *italics* is tagged with <em> tags.

Blockquotes

Blockquotes MarkdownGruber Docs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/***********************************
* Standard Blockquote
***********************************/
> This is a block
> of really cool
> text

/***********************************
* Nested Blockquote
***********************************/
> Here is a block
> that contains
>> a nest!
> and I'm back out of the nest...

Lists

Lists MarkdownGruber Docs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/***********************************
* Unordered List
***********************************/
- list item 1
- list item 2
  - sublist 1
  - sublist 2
- list item 3

/***********************************
* Ordered List
***********************************/
1. list item 1
2. list item 2
  1. sublist 1
  2. sublist 2
3. list item 3

Links

Inline Link MarkdownGruber Docs
1
This is a line with an [inline link to Google](http://www.google.com "Google").
Reference Links MarkdownGruber Docs
1
2
3
4
This line has reference links for [Google] [1] and [GitHub] [2].

  [1]: http://www.google.com "Google"
  [2]: http://www.github.com "GitHub"

Tables

Standard Table

Standard Table Markdown
1
2
3
4
// This works on GitHub
| Header 1 | Header 2     |
| -------- | ------------ |
| Content  | More content |

Code

Inline Code

Inline Code MarkdownGruber Docs
1
Here is some inline `code` that will be formatted appropriately

Code Blocks

Code Block MarkdownGitHub Docs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/***********************************
* Standard Code Block
***********************************/
Tab or four spaces for standard code block syntax:
  void replace(){
      //lots of really cool code in here
  }

/******************************************************
* GitHub Flavored Code Block with Syntax Highlighting
*******************************************************/
Three ticks before and after the code block & specify language:
  ```language
  void replace(){
      //lots of really cool code in here
  }
  ```

Images

Inline Images

Inline Image MarkdownGruber Docs
1
![alt text](path/to/img.jpg "Title")

Image References

Image Reference MarkdownGruber Docs
1
2
3
![alt text][id]

  [id]: path/to/img.jpg "Title"

Other

Horizontal Rules

Horizontal Rule MarkdownGruber Docs
1
- - -

Backslash Escape Characters

Backslash Escape CharactersGruber Docs
1
2
3
4
5
6
7
8
9
10
11
12
\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   minus sign (hyphen)
.   dot
!   exclamation mark