一份 Markdown 簡介

2019-09-29 12:32:00

一次編輯便可將文字轉換為多種格式。下面是如何開始使用 Markdown。

在很長一段時間裡,我發現我在 GitLab 和 GitHub 上看到的所有檔案都帶有 .md 擴充套件名,這是專門為開發人員編寫的檔案型別。幾週前,當我開始使用 Markdown 時,我的觀念發生了變化。它很快成為我日常工作中最重要的工具。

Markdown 使我的生活更簡易。我只需要在已經編寫的程式碼中新增一些符號,並且在瀏覽器擴充套件或開源程式的幫助下,即可將文字轉換為各種常用格式,如 ODT、電子郵件(稍後將詳細介紹)、PDF 和 EPUB。

什麼是 Markdown?

來自 維基百科的友情提示:

Markdown 是一種輕量級標示語言,具有純文字格式語法。

這意味著通過在文字中使用一些額外的符號,Markdown 可以幫助你建立具有特定結構和格式的文件。當你以純文字(例如,在記事本應用程式中)做筆記時,沒有任何東西表明哪個文字應該是粗體或斜體。在普通文字中,你在寫連結時需要將一個連結寫為 “http://example.com ”,或者寫為 “example.com”,又或“存取網站(example.com)”。這樣沒有內在的一致性。

但是如果你按照 Markdown 的方式編寫,你的文字就有了內在的一致性。計算機喜歡一致性,因為這使得它們能夠遵循嚴格的指令而不用擔心異常。

相信我;一旦你學會使用 Markdown,每一項寫作任務在某種程度上都會比以前更容易、更好。讓我們開始吧。

Markdown 基礎

以下是使用 Markdown 的基礎語法。

1、建立一個以 .md 擴充套件名結尾的文字檔案(例如,example.md)。你可以使用任何文字編輯器(甚至像 LibreOffice 或 Microsoft word 這樣的文書處理程式亦可),只要記住將其儲存為文字檔案。

Names of Markdown files

2、想寫什麼就寫什麼,就像往常一樣:

Lorem ipsumConsectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.De Finibus Bonorum et MalorumSed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.  Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

(LCTT 譯註:上述這段“Lorem ipsum”,中文又稱“亂數假文”,是一篇常用於排版設計領域的拉丁文文章,主要目的為測試文章或文字在不同字型、版型下看起來的效果。)

3、確保在段落之間留有空行。如果你習慣寫商務信函或傳統散文,這可能會覺得不自然,因為那裡段落只有一行,甚至在第一個單詞前還有一個縮排。對於 Markdown,空行(一些文書處理程式使用 ,稱為Pilcrow 符號)保證在建立一個新段落應用另一種格式(如 HTML)。

4、指定標題和副標題。對於文件的標題,在文字前面新增一個井號或雜湊符號(#)和一個空格(例如 # Lorem ipsum)。第一個副標題級別使用兩個(## De Finibus Bonorum et Malorum),下一個級別使用三個(### 第三個副標題),以此類推。注意,在井號和第一個單詞之間有一個空格。

# Lorem ipsumConsectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.## De Finibus Bonorum et MalorumSed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.  Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

5、如果你想使用粗體字元,只需將字母放在兩個星號之間,沒有空格:**對應的文字將以粗體顯示**

Bold text in Markdown

6、對於斜體,將文字放在沒有空格的下劃線符號之間:_我希望這個本文以斜體顯示_。(LCTT 譯註:有的 Markdown 流派會將用下劃線引起來的字串視作下劃線文字,而單個星號 * 參照起來的才視作斜體。從相容性的角度看,使用星號比較相容。)

Italics text in Markdown

7、要插入一個連結(像 Markdown Tutorial),把你想連結的文字放在括號裡,URL 放在括號裡,中間沒有空格:[Markdown Tutorial](<https://www.markdowntutorial.com/>)

Hyperlinks in Markdown

8、塊參照是用大於號編寫的(>)在你要參照的文字前加上大於符號和空格: > 名言參照

Blockquote text in Markdown

Markdown 教學和技巧

這些技巧可以幫助你上手 Markdown ,但它涵蓋了很多功能,不僅僅是粗體、斜體和連結。學習 Markdown 的最好方法是使用它,但是我建議你花 15 分鐘來學習這篇簡單的 Markdown 教學,學以致用,勤加練習。

由於現代 Markdown 是對結構化文字概念的許多不同解釋的融合,CommonMark 專案定義了一個規範,其中包含一組嚴格的規則,以使 Markdown 更加清晰。在編輯時手邊準備一份符合 CommonMark 的快捷鍵列表可能會有幫助。

你能用 Markdown 做什麼

Markdown 可以讓你寫任何你想寫的東西,僅需一次編輯,就可以把它轉換成幾乎任何你想使用的格式。下面的範例演示如何將用 MD 編寫簡單的文字並轉換為不同的格式。你不需要多種格式的文件-你可以僅僅編輯一次…然後擁有無限可能。

1、簡單的筆記:你可以用 Markdown 編寫你的筆記,並且在儲存筆記時,開源筆記應用程式 Turtl 將解釋你的文字檔案並顯示為對應的格式。你可以把筆記儲存在任何地方!

Turtl application

2、PDF 檔案:使用 Pandoc 應用程式,你可以使用一個簡單的命令將 Markdown 檔案轉換為 PDF:

pandoc <file.md> -o <file.pdf>

Markdown text converted to PDF with Pandoc

3、Email:你還可以通過安裝瀏覽器擴充套件 Markdown Here 將 Markdown 文字轉換為 html 格式的電子郵件。要使用它,只需選擇你的 Markdown 文字,在這裡使用 Markdown 將其轉換為 HTML,並使用你喜歡的電子郵件用戶端傳送訊息。

Markdown text converted to email with Markdown Here

現在就開始上手吧

你不需要一個特殊的應用程式來使用 Markdown,你只需要一個文字編輯器和上面的技巧。它與你已有的寫作方式相容;你所需要做的就是使用它,所以試試吧。