公司新增的產(chǎn)品中用Markdown來(lái)編寫產(chǎn)品更新日志,怎么在團(tuán)隊(duì)中介紹和推廣Markdown的使用落到我身上听皿。就簡(jiǎn)單地寫了一點(diǎn)沪斟,順便也在簡(jiǎn)書上復(fù)制一份吧。
認(rèn)識(shí)Markdown
Markdown是一種可以使用普通文本編輯器編寫的標(biāo)記語(yǔ)言查邢,通過(guò)簡(jiǎn)單的標(biāo)記語(yǔ)法,它可以使普通文本內(nèi)容具有一定的格式酵幕。Markdown的理念是扰藕,能讓文檔更容易讀、寫和隨意改芳撒。
使用Markdown來(lái)寫作自己的文稿邓深,可以節(jié)省大量的時(shí)間未桥,不需要耗費(fèi)精力在調(diào)整格式標(biāo)簽上。而且Markdown的語(yǔ)法也十分簡(jiǎn)單芥备。常用的標(biāo)記符號(hào)也不超過(guò)十個(gè)冬耿,學(xué)習(xí)成本不需要太多。下文會(huì)會(huì)結(jié)合我們的具體使用場(chǎng)景萌壳,介紹Markdown的主要語(yǔ)法亦镶。
Markdown常用語(yǔ)法介紹
標(biāo)題
在 Markdown中,如果一段文字被定義為標(biāo)題袱瓮,只要在這段文字前加#號(hào)即可缤骨。Markdown總共有六級(jí)標(biāo)題,使用方式為在編輯器中輸入#鍵尺借,在#號(hào)后加一個(gè)字符的空格绊起,然后輸入標(biāo)題名稱即可;如果是二級(jí)標(biāo)題就需要輸入兩個(gè)#褐望,依次類推勒庄。注意#和文字之間需要保留一個(gè)空格的字符,否則顯示會(huì)有問題瘫里。例如:
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題
###### 五級(jí)標(biāo)題
###### 六級(jí)標(biāo)題
具體效果如下:
一級(jí)標(biāo)題
二級(jí)標(biāo)題
三級(jí)標(biāo)題
四級(jí)標(biāo)題
五級(jí)標(biāo)題
六級(jí)標(biāo)題
粗體
Markdown 的粗體非常簡(jiǎn)單实蔽,用兩個(gè)*包含一段文本就是粗體的語(yǔ)法。 例如:
**這里是粗體語(yǔ)法**
具體效果如下:
這里是粗體語(yǔ)法
斜體
Markdown 的斜體的使用方式也非常簡(jiǎn)單谨读,用一個(gè) *包含一段文本就是斜體的語(yǔ)法局装。例如:
*這里是斜體語(yǔ)法*
具體效果如下:
這里是斜體語(yǔ)法
引用
如果你需要引用一小段別處的句子,那么就要用引用的格式劳殖,只需要在段落前加一個(gè)>就可以了铐尚。例如:
> 這里是引用的語(yǔ)法
具體效果如下:
這里是引用的語(yǔ)法
無(wú)序列表
列表的顯示只需要在文字前加上 -或 *即可變?yōu)闊o(wú)序列表。 例如:
- 無(wú)序列表1
- 無(wú)序列表2
- 無(wú)序列表3
具體效果如下:
- 無(wú)序列表1
- 無(wú)序列表2
- 無(wú)序列表3
有序列表
有序列表直接在文字前加 1. 2. 3.就可以了哆姻。 例如:
1. 有序列表1
2. 有序列表2
3. 有序列表3
具體效果如下:
- 有序列表1
- 有序列表2
- 有序列表3
鏈接
插入鏈接的語(yǔ)法是[顯示文本](鏈接地址)宣增。例如:
[知乎](https://www.zhihu.com/)
具體效果如下:
圖片
插入圖片與插入鏈接的語(yǔ)法很像,語(yǔ)法為
矛缨,只是多了一個(gè)感嘆號(hào)爹脾,其中感嘆號(hào)是英文的,[方括號(hào)]標(biāo)記圖片的替代文字箕昭,[方括號(hào)]內(nèi)可以不寫文字灵妨,但[方括號(hào)]一定要帶著,相當(dāng)于圖片的alt描述落竹。例如:

具體效果如下:
表格
表格的語(yǔ)法相對(duì)復(fù)雜一點(diǎn)泌霍,不過(guò)使用習(xí)慣就好了,關(guān)鍵是理解語(yǔ)法的含義述召,語(yǔ)法如下朱转。例如:
| 一個(gè)普通標(biāo)題 | 一個(gè)普通標(biāo)題 | 一個(gè)普通標(biāo)題 |
| ------ | ------ | ------ |
| 短文本 | 中等文本 | 稍微長(zhǎng)一點(diǎn)的文本 |
| 稍微長(zhǎng)一點(diǎn)的文本 | 短文本 | 中等文本 |
注意我們?cè)谑褂玫臅r(shí)候不需要保證 | 非得要對(duì)齊蟹地,多余的空格會(huì)被自動(dòng)忽略掉。不然有強(qiáng)迫癥的同學(xué)肯定會(huì)瘋掉藤为。
具體效果如下:
普通標(biāo)題 | 普通標(biāo)題 | 普通標(biāo)題 |
---|---|---|
短文本 | 中等文本 | 稍微長(zhǎng)一點(diǎn)的文本 |
稍微長(zhǎng)一點(diǎn)的文本 | 短文本 | 中等文本 |
如果需要設(shè)置對(duì)齊锈津,需要下面的格式來(lái)書寫。語(yǔ)法說(shuō)明如下:
|凉蜂、-、:之間的多余空格會(huì)被忽略性誉,不影響布局窿吩。
默認(rèn)標(biāo)題欄居中對(duì)齊,內(nèi)容居左對(duì)齊错览。
-:表示內(nèi)容和標(biāo)題欄居右對(duì)齊纫雁,:-表示內(nèi)容和標(biāo)題欄居左對(duì)齊,:-:表示內(nèi)容和標(biāo)題欄居中對(duì)齊倾哺。
內(nèi)容和|之間的多余空格會(huì)被忽略轧邪,每行第一個(gè)|和最后一個(gè)|可以省略,-的數(shù)量至少有一個(gè)羞海。
| 左對(duì)齊標(biāo)題 | 右對(duì)齊標(biāo)題 | 居中對(duì)齊標(biāo)題 |
| :------| ------: | :------: |
| 短文本 | 中等文本 | 稍微長(zhǎng)一點(diǎn)的文本 |
| 稍微長(zhǎng)一點(diǎn)的文本 | 短文本 | 中等文本 |
具體效果如下:
左對(duì)齊標(biāo)題 | 右對(duì)齊標(biāo)題 | 居中對(duì)齊標(biāo)題 |
---|---|---|
短文本 | 中等文本 | 稍微長(zhǎng)一點(diǎn)的文本 |
稍微長(zhǎng)一點(diǎn)的文本 | 短文本 | 中等文本 |
代碼引用
需要引用代碼時(shí)忌愚,如果引用的語(yǔ)句只有一段,不分行却邓,可以用 ` 將語(yǔ)句前后包起來(lái)硕糊。
具體效果如下:
Hello Word
如果引用的語(yǔ)句為多行,可以將```置于這段代碼的首行和末行腊徙。
具體效果如下:
<!DOCTYPE html>
<html>
<body>
<?php
$cars=array("Volvo","BMW","HAVAL");
echo "I like " . $cars[0] . "简十," . $cars[1] . " and " . $cars[2] . ".";
?>
</body>
</html>
分隔線
分隔線的使用很簡(jiǎn)單,用---或者***就可以了撬腾。例如:
---
具體效果如下:
全屏模式
當(dāng)你對(duì)Markdown的基本語(yǔ)法已經(jīng)比較熟悉的時(shí)候螟蝙,你就可以使用在全屏模式下編寫文本,這樣可以大大提高你的文本編寫速度民傻。
常見問題
換行問題
不同的編輯器中Markdown展現(xiàn)的效果不完全一致胰默,同時(shí)部分廠商也有自己的語(yǔ)法,比如有的編輯器就支持待辦事宜Todo列表和流程圖等饰潜。
我們只要掌握最常見的語(yǔ)法初坠,也就是上文提及的就完全可以應(yīng)對(duì)絕大多數(shù)使用場(chǎng)景。
換行問題
Markdown對(duì)換行的語(yǔ)法規(guī)范是空格+空格+回車換行彭雾,也就是說(shuō)碟刺,如果你要進(jìn)行換行操作,你需要先按兩次空格鍵薯酝,然后按一次回車鍵即可半沽。
分段落問題
Markdown對(duì)分段的語(yǔ)法規(guī)范是按兩次回車鍵爽柒,也就是說(shuō),如果你要進(jìn)行分段操作者填,你只需要按兩次回車鍵即可浩村。當(dāng)然,多次使用回車鍵的效果與按兩次回車鍵的效果一樣占哟,并不會(huì)產(chǎn)生多余的空白行心墅。
我們可以看到分段帶來(lái)的間距要大于換行帶來(lái)的間距,使用的時(shí)候要注意榨乎。
標(biāo)簽規(guī)范使用問題
規(guī)范的Markdown語(yǔ)法是怎燥,使用的標(biāo)簽和后面的文本要有一個(gè)字符的空格,否則可能在后臺(tái)預(yù)覽正常蜜暑,但是前臺(tái)卻不會(huì)正常顯示铐姚。
總結(jié)
熟悉以上這些Markdown的語(yǔ)法后,在日常使用中基本就沒什么大問題了肛捍,只要多加練習(xí)使用起來(lái)就可以很快體會(huì)到Markdown的簡(jiǎn)潔和易用隐绵,效率也自然提升。