(原創(chuàng)不易,轉(zhuǎn)載請(qǐng)注明原作者及原文鏈接)
一、標(biāo)題
行首插入 1 到 6 個(gè) #
分別生成一到六級(jí)標(biāo)題。如:
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
效果如下:
一級(jí)標(biāo)題
二級(jí)標(biāo)題
三級(jí)標(biāo)題
二、分隔線
一行單獨(dú)包含 3 個(gè)及以上的 *
或 _
生成一條貫穿整行的分隔線。如:
## 二級(jí)標(biāo)題
********************
正文
效果如下:
二級(jí)標(biāo)題
正文
三、段落
一段連續(xù)的文字即成一個(gè)段落,段落與段落之間至少需要一個(gè)空行。單純的回車換行不會(huì)生成段間距。如:
這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。
這是第二個(gè)段落。
這是第三個(gè)段落。
效果如下:
這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。
這是第二個(gè)段落。這是第三個(gè)段落。
四、列表
無(wú)序、有序
行首插入 1 個(gè) *
或 +
或 -
即可生成無(wú)序列表。行首插入 1.
、2.
、3.
、……即可生成有序列表。注意:符號(hào)與文本之間必須要有 1 個(gè)空格。如:
+ 無(wú)序列表
+ 無(wú)序列表
+ 無(wú)序列表
1. 有序列表
2. 有序列表
3. 有序列表
效果如下:
- 無(wú)序列表
- 無(wú)序列表
- 無(wú)序列表
- 有序列表
- 有序列表
- 有序列表
段間距
如果希望列表的列表項(xiàng)之間有段落的段間距效果,需要在列表項(xiàng)之間插入一行空行。如:
+ 無(wú)序列表
+ 無(wú)序列表
+ 無(wú)序列表
效果如下:
無(wú)序列表
無(wú)序列表
無(wú)序列表
多個(gè)段落
如果希望列表項(xiàng)包含多個(gè)段落,需要在列表項(xiàng)的附屬段落文本之前插入 4 個(gè)空格。如:
+ 這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。
這是第一個(gè)段落的附屬段落。
+ 這是第二個(gè)段落。
效果如下:
這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。
這是第一個(gè)段落的附屬段落。
這是第二個(gè)段落。
多級(jí)列表
列表項(xiàng)前插入空格即可增加列表級(jí)數(shù),相同空格數(shù)為同一級(jí)別。空格數(shù)不同,則空格數(shù)多的級(jí)別較高。建議以 4 個(gè)空格為單位進(jìn)行縮進(jìn),以確保正確顯示。如:
1. 有序列表
* 無(wú)序列表
* 無(wú)序列表
* 無(wú)序列表
* 無(wú)序列表
2. 有序列表
效果如下:
- 有序列表
- 無(wú)序列表
- 無(wú)序列表
- 無(wú)序列表
- 無(wú)序列表
- 有序列表
代碼塊
如果希望列表項(xiàng)包含代碼塊,需要在列表項(xiàng)的代碼塊文本之前插入 8 個(gè)空格。如:
+ 這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。
這是第一個(gè)段落的代碼塊。
+ 這是第二個(gè)段落。
效果如下:
這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。這是第一個(gè)段落。
這是第一個(gè)段落的代碼塊。
這是第二個(gè)段落。
五、引用塊
行首插入 >
即可生成引用塊。引用塊里可以嵌套 Markdown 語(yǔ)法。如:
你可以這樣使用分隔符:
> # 二級(jí)標(biāo)題
> ********************
> 正文
效果如下:
你可以這樣使用分隔符:
二級(jí)標(biāo)題
正文
六、代碼
行內(nèi)代碼
在代碼文本兩側(cè)分別插入 1 個(gè) `
。注意:這個(gè)鍵位于鍵盤 Esc
鍵下方。如果代碼文本中包含 `
,則需要在代碼文本兩側(cè)分別插入 2 個(gè) `
,并且如果代碼文本首尾就是 `
,還需要插入空格。如:
Chrome瀏覽器可以使用 `Ctrl + Shift + T` 組合鍵打開剛剛關(guān)閉的網(wǎng)頁(yè)
以上就是 `` ` `` 的常見用法
效果如下:
Chrome瀏覽器可以使用
Ctrl + Shift + T
組合鍵打開剛剛關(guān)閉的網(wǎng)頁(yè)
以上就是`
的常見用法
代碼塊
在行首插入 4 個(gè)空格即可生成代碼塊。也可以在代碼文本的前后插入空行,并插入 3 個(gè) `
讓整個(gè)代碼文本生成代碼塊。如:
假設(shè)你想將一個(gè)行為重復(fù) n 次,并且行為與已重復(fù)的次數(shù)相關(guān),你可以編寫如下方法:
public static void repeat(int n, IntConsumer accept) {
for (int i = 0; i < n; i++) {
accept.accept(i);
}
}
然后可以這樣去調(diào)用它:
```
public static void main(String[] args) {
repeat(10, (i) -> System.out.println("Count down: " + (9 - i)));
}
```
效果如下:
假設(shè)你想將一個(gè)行為重復(fù) n 次,并且行為與已重復(fù)的次數(shù)相關(guān),你可以編寫如下方法:
public static void repeat(int n, IntConsumer accept) { for (int i = 0; i < n; i++) { accept.accept(i); } }
然后可以這樣去調(diào)用它:
public static void main(String[] args) { repeat(10, (i) -> System.out.println("Count down: " + (9 - i))); }
高亮規(guī)則
代碼塊會(huì)根據(jù)代碼內(nèi)容自動(dòng)匹配高亮規(guī)則,如果你對(duì)匹配結(jié)果不滿意,也可以用關(guān)鍵字進(jìn)行指定。如:
``` markdown
<http://www.lxweimin.com/>
```
效果如下:
<http://www.lxweimin.com/>
經(jīng)測(cè)試,簡(jiǎn)書支持的部分關(guān)鍵字如下:
coffeescript
cpp
css
java
javascript
json
markdown
matlab
objectivec
perl
php
python
ruby
scala
scheme
sql
tex
xml
歡迎在評(píng)論區(qū)補(bǔ)充。
七、鏈接
行內(nèi)式
要顯示的鏈接文字寫在 []
里面,緊跟在后面的鏈接地址寫在 ()
里面。如果需要鼠標(biāo)懸浮在鏈接文字上時(shí)有額外的文字提示,可以在鏈接地址后面加 1 個(gè)空格,并寫在 ""
里面。如:
[簡(jiǎn)書](http://www.lxweimin.com/ "隨時(shí)隨地發(fā)現(xiàn)和創(chuàng)作內(nèi)容")
效果如下:
參考式
你也可以提前寫好鏈接,并賦于 id 值,然后在文章中需要鏈接的地方通過(guò) id 值進(jìn)行插入。注意:id 可以是字母、數(shù)字、空白和標(biāo)點(diǎn)符號(hào),但是并不區(qū)分大小寫。如:
[jianshu]: http://www.lxweimin.com/ "隨時(shí)隨地發(fā)現(xiàn)和創(chuàng)作內(nèi)容"
[簡(jiǎn)書][jianshu]
效果如下:
簡(jiǎn)單鏈接、郵箱
你還可以以更簡(jiǎn)單的形式提供鏈接或郵箱。如:
<http://www.lxweimin.com/>
<contact@jianshu.com>
效果如下:
八、圖片
圖片與鏈接插入方式基本相同,只是前面多加了 !
,也分為行內(nèi)式和參考式。如:

[touxiang]: http://upload-images.jianshu.io/upload_images/6967706-8cfcefeb48045bd5.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240 "震驚中的萌娃"
![頭像][touxiang]
效果如下:
頭像
頭像
九、強(qiáng)調(diào)
在需要強(qiáng)調(diào)的文本兩側(cè)分別插入 1 個(gè) *
或 _
可使文本傾斜顯示,插入 2 個(gè) *
或 _
可使文本加粗顯示,插入 2 個(gè) ~
可使文本擁有刪除效果,不同效果還可以疊加。
語(yǔ)法與效果如下:
語(yǔ)法 | 效果 |
---|---|
*傾斜* |
傾斜 |
**加粗** |
加粗 |
~~刪除線~~ |
|
***傾斜&加粗*** |
傾斜&加粗 |
*~~傾斜&刪除線~~* |
|
**~~加粗&刪除線~~** |
|
***~~傾斜&加粗&刪除線~~*** |
十、特殊字符轉(zhuǎn)義
如果你在文本而非代碼塊中插入 Markdown 語(yǔ)法所使用的那些特殊字符,可能會(huì)出現(xiàn)意料之外的渲染結(jié)果。你需要在特殊字符之前插入 \
來(lái)使它們正確顯示。
Markdown 支持以下這些符號(hào)前面加上反斜杠來(lái)幫助插入普通的符號(hào):
\ 反斜線
` 反引號(hào)
* 星號(hào)
_ 底線
{} 花括號(hào)
[] 方括號(hào)
() 括弧
# 井字號(hào)
+ 加號(hào)
- 減號(hào)
. 英文句點(diǎn)
! 驚嘆號(hào)
十一、表格
表格分為表頭、對(duì)齊方式、表體 3 個(gè)部分,缺一不可。單元格之間使用 |
分隔。對(duì)齊方式分為默認(rèn)、左對(duì)齊、居中對(duì)齊、右對(duì)齊 4 種形式。注意:表格前后要留有空行。多余的空白符和 -
可以使源碼看起來(lái)不那么糟糕,對(duì)渲染結(jié)果沒(méi)有影響。如:
默認(rèn) | 左對(duì)齊 | 居中對(duì)齊 | 右對(duì)齊
------- | :------ | :-----: | -------:
對(duì)齊效果 | 對(duì)齊效果 | 對(duì)齊效果 | 對(duì)齊效果
效果如下:
默認(rèn) 左對(duì)齊 居中對(duì)齊 右對(duì)齊 對(duì)齊效果 對(duì)齊效果 對(duì)齊效果 對(duì)齊效果
表格內(nèi)換行
使用 HTML 的 <br>
標(biāo)簽進(jìn)行換行。如:
標(biāo)簽 | 說(shuō)明
------ | -----
`<br>` | 這是一個(gè) HTML 標(biāo)簽<br>使用該標(biāo)簽可以強(qiáng)制換行
效果如下:
標(biāo)簽 | 說(shuō)明 |
---|---|
<br> |
這是一個(gè) HTML 標(biāo)簽 使用該標(biāo)簽可以強(qiáng)制換行 |
十二、讓文檔更美觀、易讀
- 在二級(jí)標(biāo)題下方使用分隔符
- 段落之間插入空行讓段落擁有段間距
-
「關(guān)鍵字」用
「」
而不是“”
來(lái)標(biāo)記,并考慮使用加粗效果 - 在數(shù)字、英文單詞、行內(nèi)代碼等文本的兩邊各插入 1 個(gè)半角空格
十三、參考資料
(原創(chuàng)不易,轉(zhuǎn)載請(qǐng)注明原作者及原文鏈接)