注:本文所有示例均出自Markdown官方文檔及github推出的mastering-markdown文檔。
Markdown簡介及作用
Markdown的官方文檔是這樣介紹Markdown的:
Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown.(Markdown是一種Web上表現文本的風格,你可以控制文本的展示:粗體字或者是斜體字,插入圖檔和建立清單,這些都是我們可以使用Markdown做到的事情)
Markdown用途很廣泛,例如Github上的ReadMe.md文檔就是使用Markdown這個輕量級的文本表示語言書寫的,在簡書上,你也可以使用這種語言來編輯你的文章,有些前後端對接的API文檔也可以使用Markdown語言編寫,這樣可以使你的文本更加簡單易讀。
常用文法展示
标題及字型展示
# 标題文本,可以使文本以标題形式展示,共六級标題,# 一級标題,## 二級标題,依次類推
這是一個六級标題的效果
字型展示
*This text will be italic* _This will also be italic_
**This text wiil be bold** __This will also be italic__
效果: This text will be italic This text will be bold
清單展示
* Item 1
* Item 2
* Item 2a
* Item 2b (這些代碼會讓文本呈現無序清單的形式)
1. Item 1
1. Item 2
1. Item 3
1. Item 3a
2. Item 3b (這些代碼會讓文本呈現有序清單的形式)
* A list item with a blockquote:
> This is a blockquote
> inside a list item. (當一個清單包含區塊的時候,區塊需要縮進)
效果:
- Item 1
- Item 2
- Item 2a
- Item 2b
- Item 3
- Item 3a
- Item 3b
- A list item with a blockquote:
This is a blockquote
inside a list item.
圖檔展示
![Markdown learning](https://upload.jianshu.io/users/upload_avatars/5420272/41b3aee5-049c-4d77-8b22-3a744101e5f9?imageMogr2/auto-orient/strip|imageView2/1/w/240/h/240)
這段代碼會渲染成下面的圖檔風格,文法如下:
![圖檔解釋的文本](圖檔URL)
Markdown learning
超連結、引用及分隔符
http://github.com - automatic!
[GitHub](http://github.com) //這是超連結的使用方法
As Kanye West said:
> We're living the future so
> the present is our past. //這是引用的使用方法
`<addr>` //這是單行代碼的使用方法
\```
這是多行代碼的使用方法
\``` //使用三個引号來表現代碼會讓代碼關鍵字部分高亮,如果不想讓代碼高亮,可以在代碼部分前面加上四個空格即可
http://github.com - 當直接使用一個URL時會直接解析成超連結
GitHub- 這個超連結依然指向github的官網,隻是可以自由編輯他表現出來的文本内容
表格
First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
First Header | Second Header |
---|---|
Content from cell 1 | Content from cell 2 |
Content in the first column | Content in the second column |