1. Markdown是什么
Markdown 是一種用來寫作的輕量級(jí)“標(biāo)記語言”珠漂,用簡(jiǎn)潔的語法代替排版。
從內(nèi)容到格式笼才,從圖片到鏈接漱受,甚至公式和代碼,統(tǒng)統(tǒng)搞定患整。
以Word為代表的文檔編輯器叫做富文本編輯器拜效。
Word總體上來說還是以一種傳統(tǒng)印刷的思維方式來定義頁面和排版喷众。
2. Markdown格式的優(yōu)點(diǎn)
專注高效
專注于文字內(nèi)容,而不是把精力花在排版上面紧憾。
- 全部?jī)?nèi)容都可以用鍵盤完成到千,不需要頻繁切換鼠標(biāo)操作。
- 雖然圖形化界面方便了人們的日常操作赴穗,但進(jìn)行大量?jī)?nèi)容編輯時(shí)憔四,鍵盤更為高效。
兼容性強(qiáng)
純文本格式般眉,兼容性強(qiáng)了赵。
- 在不同的編輯器內(nèi)效果統(tǒng)一,文檔轉(zhuǎn)換無丟失甸赃。特別適合于網(wǎng)絡(luò)發(fā)布和共享柿汛。
- 大家應(yīng)該都經(jīng)歷過在幾個(gè)Word文檔之間拷貝粘貼內(nèi)容,然后來回調(diào)格式就把自己搞崩潰的經(jīng)歷埠对。Markdown不會(huì)產(chǎn)生這樣的問題络断。
專業(yè)適用性
對(duì)于中短篇幅的技術(shù)類文檔特別適用。
- 原文本直觀可讀项玛,渲染后清晰美觀貌笨。
- 支持的特性能夠很好地滿足技術(shù)類文檔的要求。如多級(jí)標(biāo)題襟沮,公式編輯锥惋,代碼引用等。
對(duì)于長(zhǎng)篇的文檔开伏,原生的Markdown在目錄生成膀跌,章節(jié)自動(dòng)編號(hào)方面有缺陷。但有很多插件可以支持更豐富的功能硅则。
并且由于是純文本格式淹父,我們甚至可以自己編寫腳本來處理,利用正則表達(dá)式的強(qiáng)大功能怎虫,實(shí)現(xiàn)特定的需求暑认。
3. Markdown基本語法
3.1 標(biāo)題
標(biāo)題采用文本前加#號(hào)的方式來實(shí)現(xiàn)。#號(hào)后留一個(gè)空格大审。
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
顯示效果:
一級(jí)標(biāo)題
二級(jí)標(biāo)題
三級(jí)標(biāo)題
最多支持6級(jí)標(biāo)題顯示蘸际。
3.2 列表
無序列表
有序列表采用文本前加-號(hào)的方式來實(shí)現(xiàn)。-號(hào)后留一個(gè)空格徒扶。
- 列表內(nèi)容1
- 列表內(nèi)容2
顯示效果:
- 列表內(nèi)容1
- 列表內(nèi)容2
有序列表
有序列表采用文本前加數(shù)字.的方式來實(shí)現(xiàn)粮彤。.號(hào)后留一個(gè)空格。
1. 列表內(nèi)容1
3. 列表內(nèi)容2
6. 列表內(nèi)容3
顯示效果:
- 列表內(nèi)容1
- 列表內(nèi)容2
- 列表內(nèi)容3
有個(gè)小細(xì)節(jié)就是前面的數(shù)字并不需要嚴(yán)格排序,渲染時(shí)會(huì)自動(dòng)修正导坟。
事實(shí)上全部寫成
1.
也可以屿良。
3.3 引用
從別處引用的一段話,或者需要添加備注性質(zhì)的文字惫周,可以采用引用尘惧。
引用采用在文本前加>號(hào)的方式來實(shí)現(xiàn)。>號(hào)后留一個(gè)空格递递。
> 引用的文字
顯示效果:
引用的文字
3.4 字體格式
粗體
字體加粗采用文本兩邊用**
來標(biāo)注的方式喷橙。
**加粗的文字**
顯示效果:
加粗的文字
斜體
字體加粗采用文本兩邊用*
來標(biāo)注的方式。
*斜體的文字*
顯示效果:
斜體的文字
嵌套的粗斜體
***粗斜體的文字***
顯示效果:
粗斜體的文字
3.5 代碼
行內(nèi)代碼
行內(nèi)代碼采用文本兩邊用 \
來標(biāo)注的方式登舞。
void main()`
代碼塊
代碼塊采用代碼前后用```
來標(biāo)注的方式贰逾。
void adjustHist(Mat& src, Mat& dst)
{
vector<Mat> bgr(3);
vector<Mat> bgr2(3);
split(src, bgr);
equalizeHist(bgr[0], bgr2[0]);
equalizeHist(bgr[1], bgr2[1]);
equalizeHist(bgr[2], bgr2[2]);
merge(bgr2, dst);
}
3.6 鏈接與圖片
插入鏈接
文本中插入鏈接的方法是[]()
。
如[百度](https://www.baidu.com/)
[]中是顯示的文字菠秒。
()中是鏈接的url疙剑。
顯示效果:
百度
插入圖片
文本中插入鏈接的方法是![]()
稽煤。
如![圖片示例](http://ooo.0o0.ooo/2015/10/22/5628736fc37d1.png)
顯示效果:
![圖片示例](http://ooo.0o0.ooo/2015/10/22/5628736fc37d1.png)
圖片需要事先上傳到網(wǎng)絡(luò)圖床核芽,并得到url。
也可以在文檔的目錄下建一個(gè)文件夾酵熙,將圖片都放在其中,使用相對(duì)路徑引用驰坊。
3.7 分割線
三個(gè)*號(hào)就可以添加分割線匾二。
顯示效果:
4. 推薦工具
4.1 本地編輯器
為知筆記+Wiz.Editor.md插件
為知筆記官網(wǎng)
Wiz.Editor.md插件,也可以在為知筆記應(yīng)用中心直接下載到拳芙。
本篇說明文檔就是用這個(gè)來編寫的察藐。
利用為知筆記的云端存儲(chǔ)功能,可以實(shí)現(xiàn)多終端同步舟扎。用好了是一個(gè)良好的個(gè)人知識(shí)管理庫分飞。
MarkdownPad
MarkdownPad官網(wǎng),一個(gè)比較老牌的Markdown本地編輯器睹限。
Windows記事本
在手頭沒有其他工具的時(shí)候譬猫,不要忘了Markdown本質(zhì)上就是一個(gè)純本文格式的文檔。
即使不進(jìn)行預(yù)覽羡疗,源文檔也是有良好的可讀性的染服,用記事本完全可以實(shí)現(xiàn)所有的編輯需求。
4.2 在線編輯器
我們?cè)诰W(wǎng)上找資料的過程中叨恨,常常會(huì)搜到一些別人寫的技術(shù)博客柳刮,比如:
CSDN
博客園
還有一些開源軟件的托管站點(diǎn),比如:
Github
開源中國
它們?nèi)慷贾С植⑶医ㄗh以Markdown的方式來編輯文檔和共享。