1 基礎語法
1.1 標題
Markdown支持6種級別的標題,對應html標籤 h1 ~ h6
例如:
# 這是一級標題
## 這是二級標題
### 這是三級標題
#### 這是四級標題
##### 這是五級標題
###### 這是六級標題
效果如下:
1.2 段落及區塊引用
需要記住的是,Markdown其實就是一種易於編寫的普通文本,只不過加入了部分渲染文本的標籤而已。其最終依然會轉換爲html標籤,因此使用Markdown分段非常簡單,前後至少保留一個空行即可。
而另外一個比較常見的需求就是,我們可能希望對某段文字進行強調處理。Markdown提供了一個特殊符號>用於段首進行強調,被強調的文字部分將會高亮顯示
> 這是一段文字......
以上標記顯示效果如下:
這是一段文字…
1.3 插入鏈接或圖片
Markdown插入鏈接直接使用[]即可,中括號內容是顯示文字的內容,後面小括號緊跟着鏈接,如插入鏈接如下:
[點擊跳轉至百度](http://www.baidu.com)
顯示效果如下:
插入圖片類似,只不過是在[]前面多加歎號,中括號的內容是圖片的標題
![圖片](https://upload-images.jianshu.io/upload_images/703764-605e3cc2ecb664f6.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)
顯示效果如下:
注: 引用圖片和鏈接的唯一區別就是在最前方添加一個感嘆號。
1.4 列表
Markdown支持有序列表和無序列表兩種形式:
- 無序列表使用*或+或-標識
- 有序列表使用數字加.標識,例如:1.
* 黃瓜
* 玉米
* 茄子
+ 黃瓜
+ 玉米
+ 茄子
- 黃瓜
- 玉米
- 茄子
1. 黃瓜
2. 玉米
3. 茄子
以上標記顯示效果如下:
- 黃瓜
- 玉米
- 茄子
- 黃瓜
- 玉米
- 茄子
- 黃瓜
- 玉米
- 茄子
- 黃瓜
- 玉米
- 茄子
**注:**這裏比較有趣的地方是,對於有序列表,Markdown將只關注你的第一個項目的數字編號。例如:如果第一個項目編號是3,以此類推,第二個項目應該是4,最終將顯示爲3、4、5。而如果你指定了第一個編號,後面的編號指定錯誤也沒有關係,Markdown將只在乎你的第一個項目編號。
使用列表的一些注意事項
如果在單一列表項中包含了多個段落,爲了保證渲染正常,*與段落首字母之間必須保留四個空格
* 段落一
小段一
* 段落二
小段二
以上標記顯示效果如下:
-
段落一
小段一
-
段落二
小段二
另外,如果在列表中加入了區塊引用,區域引用標記符也需要縮進4個空格
* 段落一
> 區塊標記一
* 段落二
> 區塊標記二
-
段落一
區塊標記一
-
段落二
區塊標記二
注:記住一個原則,如果在和列表配合使用的時候出現了問題,就縮進一次,四個空格或者一個製表符代表一次縮進。如果一次縮進沒有解決問題,那就兩次。
1.5 分隔線
有時候,爲了排版漂亮,可能會加入分隔線。Markdown加入分隔線非常簡單,使用下面任意一種形式都可以
***
---
產生分隔線的語法要求比較松,符號之間添加空格也可以.
1.6 強調
有時候,我們希望對某一部分文字進行強調,使用*或_包裹即可。使用單一符號標記的效果是斜體,使用兩個符號標記的效果是加粗
*這裏是斜體*
_這裏是斜體_
**這裏是加粗**
__這裏是加粗__
這裏是斜體
這裏是斜體
這裏是加粗
這裏是加粗
2 高級用法
2.1 插入代碼塊
Markdown在IT圈子裏面比較流行的一個重要原因是,它能夠輕鬆漂亮地插入代碼。
方法是,使用反引號`進行包裹即可。如果是行內代碼引用,使用單個反引號進行包裹
這是一段var x = 3
行內代碼
如果插入一整段代碼,需要至少使用兩個以上反引號進行包裹, 看效果:
fun (x: Int, y: Int): Int {
return x + y
}
注:很多人不知道怎麼輸入反引號。在英文模式下,找到鍵盤最左側esc鍵下面的第一個鍵點擊即可。
2.2 插入表格
表格是Markdown語法中比較複雜的一個,其語法如下:
表頭|條目一|條目二
:---:|:---:|:---:
項目|項目一|項目二
以上標記顯示效果如下:
表頭 | 條目一 | 條目二 |
---|---|---|
項目 | 項目一 | 項目二 |
注:三個短斜槓左右的冒號用於控制對齊方式,只放置左邊冒號表示文字居左,只放置右邊冒號表示文字居右,如果兩邊都放置冒號表示文字居中。
2.3 特殊符號處理
Markdown使用反斜槓\插入語法中用到的特殊符號。在Markdown中,主要有以下幾種特殊符號需要處理:
\ 反斜線
` 反引號
* 星號
_ 底線
{} 花括號
[] 方括號
() 括弧
# 井字號
+ 加號
- 減號
. 英文句點
! 驚歎號
例如,如果你需要插入反斜槓,就連續輸入兩個反斜槓即可:\ => \ 。
注:在內容中輸入以上特殊符號的時候一定要注意轉義,否則將導致內容顯示不全,甚至排版混亂。