MarkDown 使用筆記

b10l07發表於2017-10-27

最近在學習Python,解除到MarkDown語法,在過去的工作中一直是使用word來編寫文件,特別是在用word寫介面文件的時候,遇到了很多蛋疼的問題,在內容編寫完成後,還需要逐個調整格式。

3893041-e0a21b582323f614.png
螢幕快照 2017-10-27 10.08.10.png

自從接觸到MarkDown,突然發現編寫文件這麼簡單,以下是一些語法,作為備忘:

一,認識 Markdown
在剛才的導語裡提到,Markdown 是一種用來寫作的輕量級「標記語言」,它用簡潔的語法代替排版,而不像一般我們用的字處理軟體 WordPages 有大量的排版、字型設定。它使我們專心於碼字,用「標記」語法,來代替常見的排版格式。例如此文從內容到格式,甚至插圖,鍵盤就可以通通搞定了。目前來看,支援 Markdown 語法的編輯器有很多,包括很多網站(例如簡書)也支援了 Markdown 的文字錄入。Markdown 從寫作到完成,匯出格式隨心所欲,你可以匯出 HTML 格式的檔案用來網站釋出,也可以十分方便的匯出 PDF 格式,這種格式寫出的簡歷更能得到 HR 的好感。甚至可以利用 CloudApp 這種雲服務工具直接上傳至網頁用來分享你的文章,全球最大的輕部落格平臺 Tumblr,也支援 Mou 這類 Markdown 工具的直接上傳。
Markdown 官方文件
這裡可以看到官方的 Markdown 語法規則文件,當然,後文我也會用自己的方式闡述這些語法的具體用法
創始人 John Gruber 的 Markdown 語法說明
Markdown 中文版語法說明

使用 Markdown 的優點
專注你的文字內容而不是排版樣式,安心寫作。
輕鬆的匯出 HTML、PDF 和本身的 .md 檔案。
純文字內容,相容所有的文字編輯器與字處理軟體。
隨時修改你的文章版本,不必像字處理軟體生成若干檔案版本導致混亂。
可讀、直觀、學習成本低。

使用 Markdown 的誤區
*We believe that writing is about content, about what you want to say – not about fancy formatting. *我們堅信寫作寫的是內容,所思所想,而不是花樣格式。— Ulysses for Mac

Markdown 旨在簡潔、高效,也由於 Markdown 的易讀易寫,人們用不同的程式語言實現了多個版本的解析器和生成器,這就導致了目前不同的 Markdown 工具整合了不同的功能(基礎功能大致相同),例如流程圖與時序圖,複雜表格與複雜公式的呈現,雖然功能的豐富並沒有什麼本質的缺點,但終歸有些背離初衷,何況在編寫的過程中很費神,不如使用專業的工具撰寫來的更有效率,所以如果你需實現複雜功能,專業的圖形介面工具會更加方便。當然,如果你對摺騰這些不同客戶端對 Markdown 的定製所帶來高階功能感到愉悅的話,那也是無可厚非的。

3893041-cc8e527390b16021.jpg
flowchart.js on Github(使用 Markdown 繪製流程圖)
flowchart.js on Github(使用 Markdown 繪製流程圖)

我該用什麼工具?


Mou for Mac

Mou for Mac

在 Mac OS X 上,我強烈建議你用 Mou 這款免費且十分好用的 Markdown 編輯器,它支援實時預覽,既左邊是你編輯 Markdown 語言,右邊會實時的生成預覽效果。不僅如此,Mou 還有一些有趣的偏好設定(Preference),例如主題(Themes)與樣式(CSS),它們可以配置出定制化的文字編輯效果與匯出效果,如果你對自帶的主題與樣式不滿意還可以到 GitHub 上搜尋其它愛好者為 Mou 編寫的更多主題樣式,匯入的方式可以在偏好設定的 Themes 或 CSS 選項中 選擇 reload。

3893041-1d517a365bc20407.jpg
Mou 的編寫與預覽視窗

Mou 的編寫與預覽視窗

如果你從事文字工作,我強烈建議你購買 Ulysses for Mac,這款軟體入圍了蘋果 Mac App Store 的 The Best of 2013。它支援更多的寫作格式、多文件的支援。Mou,iA writer 這些軟體都是基於單文件的管理方式,而 Ulysses 支援 Folder、Filter 的管理,一個 Folder 裡面可以建立多個 Sheet,Sheet 之間也可以進行 Combine 處理。

3893041-c6f93a84b14c48a2.jpg
Mac 上一些 Markdown 編輯器
Mac 上一些 Markdown 編輯器

由於筆者很少接觸 Windows,Windows 下的 Markdown 沒有過多涉獵,經朋友介紹,有兩款還算不錯,一款叫做 MarkdownPad ,另一款叫做 MarkPad

iOS 端很多 app 早已經支援了 Markdown 錄入,例如 Drafts,Day One,iA writer 等,另外 Ulysses for iPad 現在已經上架,可以說是 iOS 平臺最好的編輯器了。

在 Web端,我強烈推薦簡書這款產品,上面有無數熱愛文字的人在不停的創造,分享。在 Web 端使用 Markdown 沒有比簡書更舒服的地方了,同樣支援左右兩欄的實時預覽,字型優雅,簡潔。

3893041-73ea9273dcf0400e.jpg
簡書的編輯預覽模式

簡書的編輯預覽模式

二,Markdown 語法的簡要規則
標題


3893041-eec9b52fff7af39b.jpg
標題

標題

標題是每篇文章都需要也是最常用的格式,在 Markdown 中,如果一段文字被定義為標題,只要在這段文字前加#
號即可。

一級標題

二級標題

三級標題

以此類推,總共六級標題,建議在井號後加一個空格,這是最標準的 Markdown 語法。
列表
熟悉 HTML 的同學肯定知道有序列表與無序列表的區別,在 Markdown 下,列表的顯示只需要在文字前加上-
或*
即可變為無序列表,有序列表則直接在文字前加1.

符號要和文字之間加上一個字元的空格。


3893041-fef7275671c262a4.jpg
無序列表與有序列表

無序列表與有序列表

引用
如果你需要引用一小段別處的句子,那麼就要用引用的格式。
例如這樣

只需要在文字前加入>
這種尖括號(大於號)即可


3893041-6af7040edc1e5630.jpg
引用

引用

圖片與連結
插入連結與插入圖片的語法很像,區別在一個!

圖片為:
{ImgCap}{/ImgCap}

連結為:

插入圖片的地址需要圖床,這裡推薦圍脖圖床修復計劃CloudApp 的服務,生成URL地址即可。

3893041-89c277df28a807b7.jpg
URL 與圖片
URL 與圖片

粗體與斜體
Markdown 的粗體和斜體也非常簡單,用兩個*
包含一段文字就是粗體的語法,用一個*
包含一段文字就是斜體的語法。
例如:這裡是粗體 這裡是斜體
表格
表格是我覺得 Markdown 比較累人的地方,例子如下:
| Tables | Are | Cool || ------------- |:-------------:| -----:|| col 3 is | right-aligned | $1600 || col 2 is | centered | $12 || zebra stripes | are neat | $1 |

這種語法生成的表格如下:
Tables
Are
Cool

col 3 is
right-aligned
$1600

col 2 is
centered
$12

zebra stripes
are neat
$1

程式碼框
如果你是個程式猿,需要在文章裡優雅的引用程式碼框,在 Markdown下實現也非常簡單,只需要用兩個 ` 把中間的程式碼包裹起來。圖例:


3893041-bc45b254f042d028.jpg

使用tab
鍵即可縮排。
分割線
分割線的語法只需要三個*
號,例如:
到這裡,Markdown 的基本語法在日常的使用中基本就沒什麼大問題了,只要多加練習,配合好用的工具,寫起東西來肯定會行雲流水。更多的語法規則,其實 Mou 的 Help 文件栗子很好,當你第一次使用 Mou 時,就會顯示該文件。可以用來對用的查詢和學習。

3893041-3e1bd0323632f662.jpg

相關文章