Markdown Cheat Sheet

A Programming › Markdown cheat sheet in English by Simon Fermor

Markdown / HTML Comparison

25,230 views 5,988 downloads 9 Apr 2015 History

PRs

4.9 avg · 1 rating

Paragraphs

Markdown
Paragraphs are lines of text
(single returns are collapsed into a space)

Blank lines indicate a new paragraph

HTML
Paragraphs are lines of text (single returns are collapsed into a space)

Blank lines indicate a new paragraph

Images

Markdown
Images can be embedded: !Image of dog

HTML
Images can be embedded: <img source= "http://www.dogs.com/top_dog.png" title="" alt="Image of dog" />

Ordered Lists

Markdown	HTML
1. First Item	<li>First Item</li>
2. Second Item	<li>Second Item</li>
3. Third Item	<li>Third Item</li>

List items are enclosed in <ol></ol>

Unordered Lists

Markdown	HTML
* Alpha	<li>Alpha</li>
* Beta	<li>Beta</li>
* Gamma	<li>Gamma</li>

List items are enclosed in <ul></ul>

Headers - atx style

Markdown	HTML
# H1 Header	<h1>H1 Header</h1>
## H2 Header	<h2>H2 Header</h2>
### H3 Header	<h3>H3 Header</h3>

Headers - Setext style

Heading Level 1
==========

Heading Level 2
--------------

Text Effects

Markdown	HTML
_Italic_	<em>Italic</em>
Bold	<strong>Bold</strong>
~~Strikethrough~~	<del>Strikethrough</del>

Resources

John Gruber Markdown site: Daring Fireball
Markdown specification:CommonMark
GitHub flavored markdown:GitHub Help

Horizontal Rule

Markdown
---
*
- - -

HTML
<hr />

Links

Markdown
Links are added like this: link to my website

HTML
Links are added like this: <a href="http://www.feedmecheese.org/">link to Cheatography</a>

Block Quotes

Markdown
> This is a
> blockquote

HTML
<blockquote>
This is a
blockquote
</blockquote>

Code Blocks Option 1

Markdown
Indent text 4 characters or one tab

HTML
<pre><code>Indent text 4 characters or one tab</code></pre>

Code Blocks Option 2

Markdown
`This is code`

HTML
<code>This is code</code>

Code Syntax Highlighting

Markdown
Code fencing (with backticks) and language:
````javascript
if (isBad) {
return false
}
````

HTML
Code fencing (with backticks) and language:
<div class="highlight highlight-javascript">
<pre>
if (isBad) {
return false
}
</pre>
</div>

(incomplete, shown for GitHub)

Badges

Nice Cheat Sheet Good Cheat Sheet Downloaded from Unusual Locations × 1

Comments (4)

DaveChild 11:25 12 Apr 2015

Great cheat sheet, Simon! I think in the "text effects" section, you need to escape the asterisks around "Bold" (use a backslash), as Cheatography uses a variant of Markdown for its own formating.

Simon Fermor 00:22 13 Apr 2015

Thanks, nice catch. I just need a way to avoid back ticks being interpreted too...

DaveChild 10:07 13 Apr 2015

Hi Simon. No problem - you can now escape backticks in the same way as other special characters.

Simon Fermor 14:24 13 Apr 2015

Nice!