Markdown

Headers

1
2
3
4
5
6
7
8
# H1
### H3
###### H6
Header 1
========
Header 2
--------

Emphasis

1
2
3
4
5
*Italics* / _Italics_ # 斜体:command + i
**Bold** / __Bold__ # 粗体:command + b
~~Strikethrough~~ # 删除线

Lists

1
2
3
4
5
6
7
8
9
10
11
12
1. First ordered list item
2. Another item
* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list
4. And another item.
Some text that should be aligned with the above item.
* Unordered list can use asterisks
- minuses
+ pluses
1
2
3
4
5
6
7
8
9
10
11
12
https://github.com
[Inline-style](https://www.google.com) # command + shift + k
[Reference-style][Google]
[Reference-style][1]
leave it empty [link text]
[Google]: https://www.mozilla.org
[1]: http://slashdot.org
[link text]: http://www.reddit.com
1
2
3
[Contribution](docs/CONTRIBUTING.md)
[Contribution](./)
[Contribution](../)

Images

1
2
3
4
5
6
7
8
9
10
11
![alt text](https://xxx.png) # Inline-style
![alt text][logo] # Reference-style
[logo]: https://xxx.png
![Image alt text](/path/to/img.jpg)
![Image alt text](/path/to/img.jpg "title")
![Image alt text][img]
[img]: http://foo.com/img.jpg

Code and Syntax Highlighting / Quoting code

1
2
3
`code`
```somthing``` # ignore ""

Tables

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
| A | B | C |
|:- |:-:| -:|
| a | b | f |
| c | d | e |
| F | G | H |
A | B | C
--- | --- | ---
*a* | `b` | **c**
1 | 2 | 3
| Name | Character |
| --- | --- |
| Backtick | ` |
| Pipe | | |

Blockquotes

1
2
3
4
5
6
7
8
> This is
> a blockquote
>
> > Nested
> > Blockquote
> This is
another blockquote

Inline HTML

1
2
3
4
5
6
7
<dl>
<dt>Definition list</dt>
<dd>Is something people use sometimes.</dd>
<dt>Markdown in HTML</dt>
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>

Horizontal Rule

1
2
3
---- # Hyphens
**** # Asterisks
____ # Underscores

Task lists

1
2
3
4
- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] (Optional) Open a followup issu

More info: About task lists

Mentioning users and teams

1
@github/support What do you think about these updates?

More info: About teams

Referencing issues and pull requests

More info: Autolinked references and URLs

Using emoji

1
2
:+1:
:shipit:

More info:emoji-cheat-sheet.com

Ignoring Markdown formatting

1
Let's rename *our-new-project* to *our-old-project*.

More info: Markdown Syntax

YouTube Videos

1
2
3
4
5
<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE
" target="_blank"><img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg"
alt="IMAGE" width="240" height="180" border="10" /></a>
[![IMAGE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

Reference

writing-on-github
Markdown Cheatsheet
Rico’s Cheatsheets