一、前言
無論你是軟件開發者,還是互聯網寫作者,為了使自己寫的文檔或作品更好的流通,便于在不同場合、不同環境、不同人群的查看,亟需尋求一種通用、便于扭轉、留存的文檔格式。
在這之前、現在或者今后,你可能會存在以下這些困擾:
- 作為軟件開發者、架構師,寫的設計文檔到底應該以什么樣的格式來保存呢?是word、txt、pdf,還是html呢?這些文檔格式,在不同情況下,可能都會存在。有時為了便于評審、修改,會采用word格式;有時為了防止文檔篡改,會采用pdf格式;有時為了便于網頁瀏覽(如:GitLib),會采用html格式。難道要針對不同格式進行不同的編寫嗎?
- 作為互聯網寫作者,寫的文章希望能夠在不同的平臺能夠發表,分享給更多的人。而在不同互聯網平臺,如:微信公眾號、CSND、知乎、有道云筆記等,文章的排版會花費你大量的時間,不同平臺排版上也會存在一些差異性,甚至讓你抓狂。難道不同平臺要進行不同排版的調整嗎?
辦法總比困難多! 上述的這些困擾,Markdown就能很好的解決,接下來我們一起來了解下它吧。
二、Markdown是什么
Markdown是一種可以使用普通文本編輯器編寫的標記語言,通過簡單的標記語法,它可以使普通文本內容具有一定的格式。
Markdown具有一系列衍生版本,用于擴展Markdown的功能(如表格、腳注、內嵌HTML等等),這些功能原初的Markdown尚不具備,它們能讓Markdown轉換成更多的格式,例如LaTeX,Docbook。Markdown增強版中比較有名的有Markdown Extra、MultiMarkdown、 Maruku等。這些衍生版本要么基于工具,如Pandoc;要么基于網站,如GitHub和Wikipedia,在語法上基本兼容,但在一些語法和渲染效果上有改動。
Markdown也是最受歡迎的寫作"標記語言",它的簡潔語法代替了排版,而不像一般我們用的字處理軟件Word有大量的排版、字體設置等。它使我們更專心于碼字,用"標記"語法,來替代常見的排版格式。
目前,支持Markdown語法的編輯器、平臺、工具有很多,如:CSDN、簡書、GitLab等,有的還支持了Markdown的導入、常見格式的導出,都十分的方便、高效。
優點
- 專注你的文字內容而不是排版樣式,安心寫作。
- 輕松的導出 HTML、PDF 和本身的 .md 文件。
- 純文本內容,兼容所有的文本編輯器與字處理軟件。
- 隨時修改你的文章版本,不必像字處理軟件生成若干文件版本導致混亂。
- 可讀、直觀、學習成本低。
誤區
We believe that writing is about content, about what you want to say – not about fancy formatting.
我們堅信寫作寫的是內容,所思所想,而不是花樣格式。
Markdown旨在簡潔、高效,也由于Markdown的易讀易寫,人們用不同的編程語言實現了多個版本的解析器和生成器,這就導致了目前不同的Markdown工具集成了不同的功能(基礎功能大致相同),例如流程圖與時序圖,復雜表格與復雜公式的呈現,雖然功能的豐富并沒有什么本質的缺點,但終歸有些背離初衷,何況在編寫的過程中很費神,不如使用專業的工具撰寫來的更有效率,所以如果你需實現復雜功能,專業的圖形界面工具會更加方便。當然,如果你對折騰這些不同客戶端對 Markdown 的定制所帶來高階功能感到愉悅的話,那也是無可厚非的。
三、Markdown語法
下面介紹的是最常用的Markdown語法,包括語法說明、效果展示。其中,同一種類效果可能會有多種寫法,第一種為標準語法,不同Markdown編輯器,會支持不同的特殊語法,并且展示效果上有細微差異。
1、標題
使用#
標簽表示標題,#
和標題之間必須有空格。一級標題使用一個#
,二級標題使用兩個##
,以此類推,共有六級標題。
語法如下:
# 標題H1
## 標題H2
### 標題H3
#### 標題H4
##### 標題H5
###### 標題H6
效果如下:

2、字符效果
- 刪除線:使用~~刪除線~~或s>刪除線/s>標簽
- 斜體字:使用*斜體字*或_斜體字_標簽
- 粗體字:使用**粗體字**或__粗體字__標簽
- 上標:使用Osup>2/sup>標簽
- 下標:使用Xsub>2/sub>標簽
- 縮寫:使用HTML中的abbr標簽,如:HTML
語法如下:
~~刪除線1~~ s>刪除線2/s>
*斜體字1* _斜體字2_
**粗體字1** __粗體字2__
Xsub>2/sub>
Osup>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、引用
使用>
標簽表示引用,>>
標簽表示引用里面再套一層引用,依次類推。
語法如下:
>這是一級引用文本內容
>>這是二級引用文本內容
>>>這是三級引用文本內容
效果如下:

4、代碼高亮
代碼塊:
使用3個連續的` 標簽包圍起來。
語法如下:

效果如下:

行內代碼:
使用``標簽表示行內代碼。
語法如下:
執行命令:`npm install marked`
效果如下:

5、鏈接
使用[](link)
標簽表示鏈接。其中,[]
內的內容為要添加鏈接的文字,link
為鏈接地址。
語法如下:
[普通鏈接](https://blog.csdn.net/xcbeyond)
[普通鏈接帶標題](https://blog.csdn.net/xcbeyond "普通鏈接帶標題")
直接鏈接:https://blog.csdn.net/xcbeyond
效果如下:

6、圖片
使用
標簽導入圖片。其中,Alt text
為如果圖片無法顯示時顯示的文字,/path/to/img.jpg
為圖片所在路徑。
語法如下:

效果如下:

7、列表
列表分為有序列表、無序列表,如下:
- 有序列表:使用
1. 2. 3.
標簽表示,其中.
后面有一個空格的。
- 無序列表:使用
*
或-
或+
標簽表示。
有序列表:
語法如下:
效果如下:

無序列表:
語法如下:
+ 列表一
+ 列表二
+ 列表二-1
+ 列表二-2
+ 列表二-3
* 列表三
* 列表三-1
* 列表三-2
* 列表三-3
效果如下:

8、分割線
使用---
、***
或者* * *
標簽表示水平分割線,其中大于三個。
語法如下:
效果如下:

9、表格
語法如下:
| Heading | Heading | Heading |
| ------- | ------- | ------- |
| Cell | Cell | Cell |
| Cell | Cell | Cell |
| Heading | Heading | Heading |
| :----- | :----: | ------: |
| 左對齊 | 居中 | 右對齊 |
| 左對齊 | 居中 | 右對齊 |
效果如下:

10、流程圖
流程圖常用的有一般流程圖、序列圖,不同Markdown編輯器,語法也是不同的。如下分別說明了其中一種寫法,其他寫法可自行具體查閱相關資料。
(注:個別編輯器可能無法正常顯示效果。)
流程圖:
語法如下:

效果如下:

序列圖:
語法如下:

效果如下:

四、Markdown常用編輯器及工具
如何更好的使用Markdown,工具必不可少,在此介紹我用過的幾款工具,分享給大家,以滿足不同使用場景。
對于工具而言,只要自己用著順手,就是最好的
1、Typora
Typora是一款輕便簡潔的Markdown編輯器,支持即時渲染技術,這也是與其他Markdown編輯器最顯著的區別。即時渲染使得你寫Markdown就想是寫Word文檔一樣流暢自如,不像其他編輯器的有編輯欄和顯示欄。并且支持多種主題以供選擇,如:GitHub、Newsprint等,如下圖所示。
官方地址:https://www.typora.io/

2、MarkdownPad2
MarkdownPad2是一個windows上的Markdown編輯器,需下載安裝,便于離線使用,如下圖所示。
官方地址:http://markdownpad.com/

3、Mou
Mou是Mac上的Markdown編輯器,兩欄界面,直觀清爽,功能簡潔到位,而且免費,如小圖所示。
不僅如此,Mou還有一些有趣的偏好設置(Preference),例如主題(Themes)與樣式(CSS),它們可以配置出定制化的文本編輯效果與導出效果,如果你對自帶的主題與樣式不滿意還可以到 GitHub上搜索其它愛好者為Mou編寫的更多主題樣式,導入的方式可以在偏好設置的Themes或CSS選項中選擇reload。
官方地址:http://25.io/mou/

4、MdEditor
mdeditor是一個在線編輯markdown的工具,無需本地安裝,在線隨時編輯、直接預覽、隨時導出,還提供對應標簽的圖標快捷操作,如下圖所示。
在線編輯完后,可導出保存到本地.md
文件即可。
官方地址:https://www.mdeditor.com/

5、coolaf md
我姑且就叫它為coolaf md,它是一款在線Markdown編輯、各種格式導出的工具,支持導出Word、HTML、PDF格式的文檔,非常好用,強烈推薦使用,如下圖所示。
官方地址:http://coolaf.com/tool/md

6、Md2All
Md2All是一款在線Markdown編輯,方便復制粘貼,一鍵排版,自定義CSS,80多種代碼高亮,所有的樣式渲染非常完美,包括圖片加字也有方案支持。無需作任何調整就能一鍵復制到微信公眾號、博客園、掘金、知乎、csdn、51cto等平臺,如下圖所示。
官方地址:http://md.aclickall.com/

參考文章:
https://zhuanlan.zhihu.com/p/92312642https://www.jianshu.com/p/1e402922ee32http://markdownpad.com/http://25.io/mou/
到此這篇關于一文了解文檔寫作利器 Markdown 的文章就介紹到這了,更多相關Markdown 寫作利器內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持腳本之家!
您可能感興趣的文章:- markdown簡介和語法介紹
- Markdown語法備忘
- 如何使用Gitblog和Markdown建自己的博客
- CommonMark 使用教程:將 Markdown 語法轉成 Html