文档写作利器：Markdown
一、前言
無(wú)論你是軟件開發(fā)者，還是互聯(lián)網(wǎng)寫作者，為了使自己寫的文檔或作品更好的流通，便于在不同場(chǎng)合、不同環(huán)境、不同人群的查看，亟需尋求一種通用、便于扭轉(zhuǎn)、留存的文檔格式。
在這之前、現(xiàn)在或者今后，你可能會(huì)存在以下這些困擾：
- 作為軟件開發(fā)者、架構(gòu)師，寫的設(shè)計(jì)文檔到底應(yīng)該以什么樣的格式來(lái)保存呢？是word、txt、pdf，還是html呢？這些文檔格式，在不同情況下，可能都會(huì)存在。有時(shí)為了便于評(píng)審、修改，會(huì)采用word格式；有時(shí)為了防止文檔篡改，會(huì)采用pdf格式；有時(shí)為了便于網(wǎng)頁(yè)瀏覽(如：GitLib)，會(huì)采用html格式。難道要針對(duì)不同格式進(jìn)行不同的編寫嗎？
- 作為互聯(lián)網(wǎng)寫作者，寫的文章希望能夠在不同的平臺(tái)能夠發(fā)表，分享給更多的人。而在不同互聯(lián)網(wǎng)平臺(tái)，如：微信公眾號(hào)、CSND、知乎、有道云筆記等，文章的排版會(huì)花費(fèi)你大量的時(shí)間，不同平臺(tái)排版上也會(huì)存在一些差異性，甚至讓你抓狂。難道不同平臺(tái)要進(jìn)行不同排版的調(diào)整嗎？
辦法總比困難多！ 上述的這些困擾，Markdown就能很好的解決，接下來(lái)我們一起來(lái)了解下它吧。
二、Markdown是什么
Markdown是一種可以使用普通文本編輯器編寫的標(biāo)記語(yǔ)言，通過(guò)簡(jiǎn)單的標(biāo)記語(yǔ)法，它可以使普通文本內(nèi)容具有一定的格式。
Markdown具有一系列衍生版本，用于擴(kuò)展Markdown的功能（如表格、腳注、內(nèi)嵌HTML等等），這些功能原初的Markdown尚不具備，它們能讓Markdown轉(zhuǎn)換成更多的格式，例如LaTeX，Docbook。Markdown增強(qiáng)版中比較有名的有Markdown Extra、MultiMarkdown、 Maruku等。這些衍生版本要么基于工具，如Pandoc；要么基于網(wǎng)站，如GitHub和Wikipedia，在語(yǔ)法上基本兼容，但在一些語(yǔ)法和渲染效果上有改動(dòng)。
Markdown也是最受歡迎的寫作"標(biāo)記語(yǔ)言"，它的簡(jiǎn)潔語(yǔ)法代替了排版，而不像一般我們用的字處理軟件Word有大量的排版、字體設(shè)置等。它使我們更專心于碼字，用"標(biāo)記"語(yǔ)法，來(lái)替代常見的排版格式。
目前，支持Markdown語(yǔ)法的編輯器、平臺(tái)、工具有很多，如：CSDN、簡(jiǎn)書、GitLab等，有的還支持了Markdown的導(dǎo)入、常見格式的導(dǎo)出，都十分的方便、高效。
優(yōu)點(diǎn)
- 專注你的文字內(nèi)容而不是排版樣式，安心寫作。
- 輕松的導(dǎo)出 HTML、PDF 和本身的 .md 文件。
- 純文本內(nèi)容，兼容所有的文本編輯器與字處理軟件。
- 隨時(shí)修改你的文章版本，不必像字處理軟件生成若干文件版本導(dǎo)致混亂。
- 可讀、直觀、學(xué)習(xí)成本低。
誤區(qū)
We believe that writing is about content, about what you want to say – not about fancy formatting.
我們堅(jiān)信寫作寫的是內(nèi)容，所思所想，而不是花樣格式。
Markdown旨在簡(jiǎn)潔、高效，也由于Markdown的易讀易寫，人們用不同的編程語(yǔ)言實(shí)現(xiàn)了多個(gè)版本的解析器和生成器，這就導(dǎo)致了目前不同的Markdown工具集成了不同的功能（基礎(chǔ)功能大致相同），例如流程圖與時(shí)序圖，復(fù)雜表格與復(fù)雜公式的呈現(xiàn)，雖然功能的豐富并沒(méi)有什么本質(zhì)的缺點(diǎn)，但終歸有些背離初衷，何況在編寫的過(guò)程中很費(fèi)神，不如使用專業(yè)的工具撰寫來(lái)的更有效率，所以如果你需實(shí)現(xiàn)復(fù)雜功能，專業(yè)的圖形界面工具會(huì)更加方便。當(dāng)然，如果你對(duì)折騰這些不同客戶端對(duì) Markdown 的定制所帶來(lái)高階功能感到愉悅的話，那也是無(wú)可厚非的。
三、Markdown語(yǔ)法
下面介紹的是最常用的Markdown語(yǔ)法，包括語(yǔ)法說(shuō)明、效果展示。其中，同一種類效果可能會(huì)有多種寫法，第一種為標(biāo)準(zhǔn)語(yǔ)法，不同Markdown編輯器，會(huì)支持不同的特殊語(yǔ)法，并且展示效果上有細(xì)微差異。
1、標(biāo)題
使用#標(biāo)簽表示標(biāo)題，#和標(biāo)題之間必須有空格。一級(jí)標(biāo)題使用一個(gè)#，二級(jí)標(biāo)題使用兩個(gè)##，以此類推，共有六級(jí)標(biāo)題。
語(yǔ)法如下：
# 標(biāo)題H1 ## 標(biāo)題H2 ### 標(biāo)題H3 #### 標(biāo)題H4 ##### 標(biāo)題H5 ###### 標(biāo)題H6效果如下：
2、字符效果
- 刪除線：使用~~刪除線~~或<s>刪除線</s>標(biāo)簽
- 斜體字：使用*斜體字*或_斜體字_標(biāo)簽
- 粗體字：使用**粗體字**或__粗體字__標(biāo)簽
- 上標(biāo)：使用O<sup>2</sup>標(biāo)簽
- 下標(biāo)：使用X<sub>2</sub>標(biāo)簽
- 縮寫：使用HTML中的abbr標(biāo)簽，如：HTML
語(yǔ)法如下：
~~刪除線1~~ <s>刪除線2</s> *斜體字1* _斜體字2_ **粗體字1** __粗體字2__ X<sub>2</sub> O<sup>2</sup> The <abbr title="Hyper Text Markup Language">HTML</abbr> specification is maintained by the <abbr title="World Wide Web Consortium">W3C</abbr>.效果如下：
3、引用
使用>標(biāo)簽表示引用，>>標(biāo)簽表示引用里面再套一層引用，依次類推。
語(yǔ)法如下：
>這是一級(jí)引用文本內(nèi)容 >>這是二級(jí)引用文本內(nèi)容 >>>這是三級(jí)引用文本內(nèi)容效果如下：
4、代碼高亮
代碼塊：
使用3個(gè)連續(xù)的` 標(biāo)簽包圍起來(lái)。
語(yǔ)法如下：
效果如下：
行內(nèi)代碼：
使用``標(biāo)簽表示行內(nèi)代碼。
語(yǔ)法如下：
執(zhí)行命令：`npm install marked`效果如下：
5、鏈接
使用[](link)標(biāo)簽表示鏈接。其中，[]內(nèi)的內(nèi)容為要添加鏈接的文字，link為鏈接地址。
語(yǔ)法如下：
[普通鏈接](https://blog.csdn.net/xcbeyond) [普通鏈接帶標(biāo)題](https://blog.csdn.net/xcbeyond "普通鏈接帶標(biāo)題") 直接鏈接：<https://blog.csdn.net/xcbeyond>效果如下：
6、圖片
使用標(biāo)簽導(dǎo)入圖片。其中，Alt text為如果圖片無(wú)法顯示時(shí)顯示的文字，/path/to/img.jpg為圖片所在路徑。
語(yǔ)法如下：
效果如下：
7、列表
列表分為有序列表、無(wú)序列表，如下：
- 有序列表：使用1. 2. 3.標(biāo)簽表示，其中.后面有一個(gè)空格的。
- 無(wú)序列表：使用*或-或+標(biāo)簽表示。
有序列表:
語(yǔ)法如下：
1. 第一行 2. 第二行 3. 第三行效果如下：
無(wú)序列表:
語(yǔ)法如下：
+ 列表一 + 列表二+ 列表二-1+ 列表二-2+ 列表二-3 * 列表三* 列表三-1* 列表三-2* 列表三-3效果如下：
8、分割線
使用---、***或者* * *標(biāo)簽表示水平分割線，其中大于三個(gè)。
語(yǔ)法如下：
--- *** * * *效果如下：
9、表格
語(yǔ)法如下：
| Heading | Heading | Heading | | ------- | ------- | ------- | | Cell | Cell | Cell | | Cell | Cell | Cell || Heading | Heading | Heading | | :----- | :----: | ------: | | 左對(duì)齊 | 居中 | 右對(duì)齊 | | 左對(duì)齊 | 居中 | 右對(duì)齊 |效果如下：
10、流程圖
流程圖常用的有一般流程圖、序列圖，不同Markdown編輯器，語(yǔ)法也是不同的。如下分別說(shuō)明了其中一種寫法，其他寫法可自行具體查閱相關(guān)資料。
（注：個(gè)別編輯器可能無(wú)法正常顯示效果。）
流程圖：
語(yǔ)法如下：
效果如下：
序列圖：
語(yǔ)法如下：
效果如下：
四、Markdown常用編輯器及工具
如何更好的使用Markdown，工具必不可少，在此介紹我用過(guò)的幾款工具，分享給大家，以滿足不同使用場(chǎng)景。
對(duì)于工具而言，只要自己用著順手，就是最好的
1、Typora
Typora是一款輕便簡(jiǎn)潔的Markdown編輯器，支持即時(shí)渲染技術(shù)，這也是與其他Markdown編輯器最顯著的區(qū)別。即時(shí)渲染使得你寫Markdown就想是寫Word文檔一樣流暢自如，不像其他編輯器的有編輯欄和顯示欄。并且支持多種主題以供選擇，如：GitHub、Newsprint等，如下圖所示。
官方地址：https://www.typora.io/
2、MarkdownPad2
MarkdownPad2是一個(gè)windows上的Markdown編輯器，需下載安裝，便于離線使用，如下圖所示。
官方地址：http://markdownpad.com/
3、Mou
Mou是Mac上的Markdown編輯器，兩欄界面，直觀清爽，功能簡(jiǎn)潔到位，而且免費(fèi)，如小圖所示。
不僅如此，Mou還有一些有趣的偏好設(shè)置（Preference），例如主題（Themes）與樣式（CSS），它們可以配置出定制化的文本編輯效果與導(dǎo)出效果，如果你對(duì)自帶的主題與樣式不滿意還可以到 GitHub上搜索其它愛(ài)好者為Mou編寫的更多主題樣式，導(dǎo)入的方式可以在偏好設(shè)置的Themes或CSS選項(xiàng)中選擇reload。
官方地址：http://25.io/mou/
4、MdEditor
mdeditor是一個(gè)在線編輯markdown的工具，無(wú)需本地安裝，在線隨時(shí)編輯、直接預(yù)覽、隨時(shí)導(dǎo)出，還提供對(duì)應(yīng)標(biāo)簽的圖標(biāo)快捷操作，如下圖所示。
在線編輯完后，可導(dǎo)出保存到本地.md文件即可。
官方地址：https://www.mdeditor.com/
5、coolaf md
我姑且就叫它為coolaf md，它是一款在線Markdown編輯、各種格式導(dǎo)出的工具，支持導(dǎo)出Word、HTML、PDF格式的文檔，非常好用，強(qiáng)烈推薦使用，如下圖所示。
官方地址：http://coolaf.com/tool/md
6、Md2All
Md2All是一款在線Markdown編輯，方便復(fù)制粘貼，一鍵排版，自定義CSS，80多種代碼高亮，所有的樣式渲染非常完美，包括圖片加字也有方案支持。無(wú)需作任何調(diào)整就能一鍵復(fù)制到微信公眾號(hào)、博客園、掘金、知乎、csdn、51cto等平臺(tái)，如下圖所示。
官方地址：http://md.aclickall.com/
參考文章：
總結(jié)
以上是生活随笔為你收集整理的文档写作利器：Markdown的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇： 百度地图接口绘制任意多边形并获取每个点的
- 下一篇： C语言程序设计教程 北京邮电,C语言程序