Markdown Summary

Misc series

Posted by Micah on September 11, 2019

Background

Markdown is used very frequently in documentation and README. It is very neccessary to summarize the common syntax and usage.

Basic Syntax

Titles

# This is the first level title
## This is the second level title
### This is the third level title
#### This is the fourth level title
##### This is the fifth level title
###### This is the sixth level title

Fonts

*Italic*
**Bold**
***Italic Bold***
~~Strikethrough~~
`Highlight`

Reference

>This is the content of the citation
>>This is the content of the citation
>>>This is the content of the citation

Dividing Line

---
----
***
*****

same effect

Picture

![pic alt](pic_addr "pic_title")

example:
![blockchain](https://ss0.bdstatic.com/70cFvHSh_Q1YnxGkpoWK1HF6hhy/it/
u=702257389,1274025419&fm=27&gp=0.jpg "blockchain")
[Hyperlink_name](Hyperlink_addr "Hyperlink_title")
Hyperlink_title is optional

Example:
[Google](http://google.com)
[Baidu](http://baidu.com)

Unordered List

can use any type of - + * , need to add space after it. the effect is same.

- list content
+ list content
* list content

number with dot, need to add space after the dot.

1. first line
2. second line
3. third line