Markdown 語法說明 (簡體中文版)
Markdown 書寫風(fēng)格指南
Markdown Guide
獻(xiàn)給寫作者的 Markdown 新手指南
文件擴(kuò)展名
使用更短更流行的.md,而不是.mkd或.markdown
文件名
小寫,用連字符代替空格,例如file-name.md
空行
不同元素間空一行。文本的段落之間空一行。
#### 標(biāo)題
內(nèi)容
#### 標(biāo)題
內(nèi)容
代碼塊
使用'```'包含多行代碼,這樣最外層代碼不需要縮進(jìn),而且可以指明語言。
```ruby
a = 1
```
行內(nèi)代碼塊
使用行內(nèi)代碼塊標(biāo)記文件路徑、類名、屬性名、方法名、語言關(guān)鍵詞。
行內(nèi)代碼塊(Objective-C)
- 協(xié)議名
<xxx> - 方法名
- xxx:
行內(nèi)代碼塊(Swift)
- 協(xié)議名
<xxx> - 方法名
xxx()
內(nèi)容
當(dāng)出現(xiàn)英文單詞時(shí),前后有中文則需空一格,若英文單詞前后是中文標(biāo)點(diǎn)符號(hào),因?yàn)榭臻g足夠則不需要再空一格。
標(biāo)題
#和內(nèi)容之間空一格,不使用閉合的#標(biāo)記,盡量不越級(jí)使用。不需要在標(biāo)題最后加入標(biāo)點(diǎn)符號(hào)。
# 標(biāo)題 1
## 標(biāo)題 2
### 標(biāo)題 3
引用
'>'和內(nèi)容之間空一格,每一行都使用'>'。
> Long line
>
> that was wrapped.
列表
無序列表使用連字符'-',不建議使用'*',因?yàn)槿菀缀图哟只煜?,不使?+'是因?yàn)椴涣餍小T谟行蚝蜔o序中優(yōu)先使用無序列表,如果使用有序列表的話,則僅僅使用1.,這種情況下,既可以正確展示順序,并且在列表中增加或刪除列表項(xiàng)都比較方便。
1. a
1. b
1. c
列表項(xiàng)的內(nèi)容前統(tǒng)一空一格。換行內(nèi)容與第一行對(duì)齊。列表項(xiàng)之間不空行。標(biāo)點(diǎn)符號(hào)視情況而定,如果成句或成段的話,可以加標(biāo)點(diǎn)符號(hào)。
水平橫線
使用3個(gè)連續(xù)的連字符表示---
強(qiáng)調(diào)
使用雙星號(hào)表示加粗**bold**,使用單星號(hào)表示斜體*italic*,因?yàn)橄啾认聞澗€可讀性更高。
表格
用 | 包裹表格的每一行。豎直對(duì)齊所有表格邊框。將標(biāo)題和內(nèi)容用連字符分割。| 周圍必須要有一個(gè)空格。列的寬度通過列中最長的單元格確定。
| header | Long header |
|--------|-------------|
| abc | def |
| abc2 | def2 |
表格中的內(nèi)容可以使用 HTML 標(biāo)簽<br>、<br/>或<br />進(jìn)行換行。應(yīng)使用更規(guī)范的<br />。簡書不支持<br />,所以用<br/>。