HTML | Notes |
---|---|
<h1>...</h1> - <h6>...</h6> |
Header 1-6 |
<p>...</p> |
Paragraph |
<br> |
Hard Line Break |
<i>...</i> or <em>...</em> |
Italic Text (Emphasis) |
<b>...</b> or <strong>...</strong> |
Bold Text (Strong Emphasis) |
<code>...</code> |
Code (Monospace Text) |
<del>...</del> |
Deleted (Strikethrough) Text |
<ul>(<li>...</li>)+</ul> |
Unordered (Bullet) List |
<ol>(<li>...</li>)+</ol> |
Ordered (Numbered) List |
<a href="...">...</a> |
Link |
<img src="..." alt="..."> |
Image with Alt(ernative) Text |
<table>(<tr>(<td>...</td>)+</tr>)+</table> |
Table |
<pre><code>...</code></pre> |
Preformatted Code Block |
<blockquote>...<blockquote> |
Blockquote |
<hr> |
Horizontal Rule |
<!-- ... --> |
Comments |
# Header 1
## Header 2
### Header 3
#### Header 4 ####
##### Header 5 #####
###### Header 6 ######
Resulting in:
</>
or
Header 1
=========
Header 2
---------
Resulting in:
</>
This is a paragraph. Paragraphs are separated
by a blank line.
This is another paragraph.
Resulting in:
This is a paragraph. Paragraphs are separated by a blank line.
This is another paragraph.
</>
Leave two spaces at the end of a line to do a line break.··↵
This is a new line.··↵
This is another new line.
Resulting in:
Leave two spaces at the end of a line to do a line break.
This is a new line.
This is another new line.
</>
Italic (Emphasis) • Bold (Strong Emphasis) • Code (Monospaced) • Deleted (Strikethrough)
This text is *italic*.
or
This text is _italic_ too.
Resulting in:
This text is italic.
This text is italic too.
</>
This text is **bold**.
or
This text is __bold__ too.
Resulting in:
This text is bold.
This text is bold too.
</>
This text is `monospaced`.
Resulting in:
This text is monospaced
.
</>
This text is ~~deleted~~.
Resulting in:
This text is deleted.
</>
Unordered (Bullet) • Ordered (Numbered)
- Item 1
- Item 2
- Item 2a -- indent nested list with two spaces or more
- Item 2b
or
* Item 1
* Item 2
* Item 2a
* Item 2b
or
+ Item 1
+ Item 2
+ Item 2a
+ Item 2b
Resulting in:
- Item 1
- Item 2
- Item 2a
- Item 2b
</>
1. A list item
2. Another list item
- A sublist item
- Another sublist item
Resulting in:
- A list item
- Another list item
- A sublist item
- Another sublist item
</>
Inline • Reference • Automatic
[Link Text](http://example.com)
[Link Text](http://example.com "Title") -- add title attribute
[Link Text](/quickrefs/readme.html) -- use absolute path (starts with /)
[Link Text](../readme.html) -- use relative path
[Link Text](#chapter1) -- use intra-page anchors
Resulting:
Link Text Link Text Link Text Link Text Link Text
</>
[Link Text][id]
[GitHub][github]
[Git][git]
[Mastering Markdown][1]
[Markdown Basics][2]
...
[id]: http://example.com
[github]: http://github.com -- use alphanumberic ids
[git]: http://git-scm.com "Offical Git Site" -- add title attribute
[1]: http://guides.github.com/mastering-markdown -- use numeric ids
[2]: http://help.github.com/articles/markdown-basics
Resulting in:
Link Text GitHub Git Mastering Markdown Markdown Basics
</>
<http://example.com>
<http://github.com>
<http://help.github.com/articles/markdown-basics>
Resulting in:
http://example.com http://github.com http://help.github.com/articles/markdown-basics
</>
Inline • Reference
![Alt Text](http://example.com/logo.png)
![Text](/i/logo.png) -- use absolute path (starts with \)
![Text](../logo.png) -- use relative path
![](logo.png) -- alternative text optional e.g. leave empty
![](logo.png "Title") -- add title attribute
![Alt Text][logo]
![Text][1]
![Text][2]
![][3]
...
[logo]: http://example.com/logo.png
[1]: /i/logo.png -- use absolute path (starts with \)
[2]: ../logo.png -- use relative path
[3]: logo.png "Title" -- add title attribute
Standard • Options
| Header A | Header B | Header C |
| -------- | -------- | -------- |
| Text A1 | Text B1 | Text C1 |
| Text A2 | Text B2 | Text C2 |
or
Header A | Header B | Header C
-------- | -------- | --------
Text A1 | Text B1 | Text C1
Text A2 | Text B2 | Text C2
Resulting in:
Header A | Header B | Header C |
---|---|---|
Text A1 | Text B1 | Text C1 |
Text A2 | Text B2 | Text C2 |
</>
| Left | Centered | Right |
| -------- | :-------: | -------: | -- use :---- for left aligned
| Text | Yes | 12.3 | -- use :---: for centered
| Text | Yes | 567.8 | -- use ----: for right aligned
Resulting in:
Left | Centered | Right |
---|---|---|
Text | Yes | 12.3 |
Text | Yes | 567.8 |
</>
This is comma-separated values (CSV) example:
····Date,Team1,Team2,FT,HT -- indent with four spaces
····2013-08-17,Arsenal,Aston Villa,1-3,1-1
····2013-08-17,Liverpool,Stoke,1-0,1-0
····2013-08-17,Swansea,Man United,1-4,0-2
····2013-08-18,Chelsea,Hull,2-0,2-0
or
This is comma-separated values (CSV) example:
``` -- wrap with three backticks (`)
Date,Team1,Team2,FT,HT
2013-08-17,Arsenal,Aston Villa,1-3,1-1
2013-08-17,Liverpool,Stoke,1-0,1-0
2013-08-17,Swansea,Man United,1-4,0-2
2013-08-18,Chelsea,Hull,2-0,2-0
```
Resulting in:
This is comma-separated values (CSV) example:
Date,Team1,Team2,FT,HT
2013-08-17,Arsenal,Aston Villa,1-3,1-1
2013-08-17,Liverpool,Stoke,1-0,1-0
2013-08-17,Swansea,Man United,1-4,0-2
2013-08-18,Chelsea,Hull,2-0,2-0
</>
As Grace Hopper said:
> I've always been more interested
> in the future than in the past.
or
As Grace Hopper said:
> I've always been more interested -- shortcut version
in the future than in the past. -- email-style quote (>) only required on first line
Resulting in:
As Grace Hopper said:
I've always been more interested in the future than in the past.
</>
--- -- three or more dashes
or
- - -
or
*** -- three or more asterisks
or
* * *
or
___ -- three or more underscores
Resulting in:
</>
<!-- Add your comments here. -->
or
<!--
Add your comments here.
-->
Resulting in:
</>
Note: Use the backslash (\
) to escape special markdown characters:
\\ => \ ackslash
\` => ` backtick
\* => * asterisk e.g. \*literal asterisks\* -- no bold text
\_ => _ underscore
\{ or \} => {} curly braces
\[ or \] => [] square brackets
\( or \) => [] parentheses
\# => # hash mark
\+ => + plus sign
\- => - minus sign (hyphen / dash)
\. => . dot e.g. 2020\. What a great year. -- no numbered list item
\! => ! exclamation mark
Note: HTML entities in code and code blocks get auto-escaped:
< => <
> => > e.g. <html> => <html>
& => &
Text | Pretty | Notes |
---|---|---|
"Hello, World" |
“Hello, World” | uses “ (“ ) and ” (” ) |
'Hello, World' |
‘Hello, World’ | uses ‘ (&lquo; ) and ’ (&rquo; ) |
-- |
– | uses – (– ) |
--- |
— | uses — (— ) |
... |
… | uses … (… ) |
...
Text | Pretty | Notes |
---|---|---|
(c) or (C) |
© | uses © (© ) |
(r) or (R) |
® | uses ® (® ) |
...
Text | Emoji |
---|---|
:smile: |
😄 |
:wink: |
😉 |
:grin: |
😁 |
:sunglasses: |
😎 |
:rage: |
😡 |
:tada: |
🎉 |
:book: |
📖 |
:gem: |
💎 |
:+1: |
👍 |
and many more
Thanks
Michel Fortin • Waylan Limberg
License
The quick reference is dedicated to the public domain. Use it as you please with no restrictions whatsoever.
Questions? Comments?
Send them along to the markdown-discuss mailing list. Thanks!