Markdown:寫技術文檔、個人博客和讀書筆記都很好用的輕量級標記語言

Foreword

大道至簡。有寫作習慣的小夥伴大概都知道 Markdown 這種易讀易寫、簡單到極致的語言。簡單到什麼程度呢?講真,會打字就會用。

Markdown 是什麼?

Markdown 是一種輕量級標記語言,這個語言的目的是希望大家使用「易於閱讀、易於撰寫的純文字格式,並選擇性的轉換成有效的 XHTML(或是 HTML)」。

Markdown 既可以用來寫產品的中英文技術文檔、使用說明,也可以用來寫個人博客。許多網站都使用 Markdown 或是其變種,例如 GitHub、reddit、簡書。

說起 Markdown,必然要說到兩個人:John GruberAaron Swartz。John Gruber 在 2004 年創造了 Markdown 語言,在語法上有很大一部分是跟 Aaron Swartz 共同合作的。

John Gruber 是一名來自美國賓夕凡尼亞州的作家、博客編者和用戶界面設計師。他在 Drexel University 獲取計算機科學理學士後,先後在 Bare Bones Software 和 Joyent 工作。2002年起,他撰寫了科技博客 Daring Fireball,還主持了播客 The Talk Show。2013年,他和 Brent Simmons、Dave Wiskus 創辦了 Q Branch,並開發了 Vesper 筆記應用程序。

Aaron Swartz 出生於 1986 年,可謂互聯網界的奇才,可惜 2013 年便自殺身亡,英年早逝。2014 年上映的記錄片《互聯網之子》記錄了他短暫但輝煌的一生。紀錄片英文名為:The Internets Own Boy: The Story of Aaron Swartz

該紀錄片豆瓣評分 9.1,強烈推薦。

互聯網之子:亞倫斯沃茨的故事_騰訊視頻 https://v.qq.com/x/cover/a0133unphsm/a0133unphsm.html

Markdown 語法有多簡單?

Markdown 的語法超級簡單,兩分鐘了解一下就可上手。這裡舉幾個例子告訴你有多簡單:

1. 標題

通過輸入特定數量的井號 "#" 即可實現不同級別的標題:

# 一級標題n## 二級標題n### 三級標題n#### 四級標題n

顯示效果如下:

一級標題

二級標題

三級標題

四級標題

2. 列表

Markdown 支持有序列表和無序列表。

無序列表使用星號、加號或是減號均可實現。例如:nn* PingCAPn* TiDBn* TiKVnn效果等同於:nn+ PingCAPn+ TiDBn+ TiDBnn還等同於:nn- PingCAPn- TiDBn- TiKVnn有序列表使用數字接一個英文句點即可實現。例如:nn1. PingCAPn2. TiDBn3. Databasen n

顯示效果如下:

3. 鏈接

行內鏈接實現方式:[鏈接文字](鏈接地址)。例如:

[PingCAP · GitHub](https://github.com/pingcap) n

顯示效果如下:

PingCAP · GitHub

另外,還支持參考式鏈接,這裡暫不詳述。

4. 強調

Markdown 使用星號 "*" 和底線 "_" 來實現強調效果。例如:

# 前兩個顯示為斜體效果nn*TiDB*nn_TiDB_nn# 後兩個顯示為加粗效果nn**TiDB**nn__TiDB__n

顯示效果如下:

TiDB

TiDB

TiDB

TiDB

5. 其它

Markdown 語法還支持引用、圖片、代碼塊等,不同的 Markdown 編輯器又有一些具體的擴展,足以滿足沉浸式寫作的排版要求。如果你有寫作需求,建議試一試,可以遠離複雜排版的干擾,讓你專心寫作。

有哪些 Markdown 編輯器?

Markdown 編輯器有很多,這裡介紹幾種 Mac 平台、Windows 平台適用的編輯器和在線編輯器。大家可以試用一下,看看自己鍾愛哪款。

Mac 平台

1. MacDown

2. Typora

同樣適用 Windows 平台

3. Ulysses

4. Mou

Windows 平台

1. MarkdownPad

2. Typora

在線編輯器

1. Dillinger.io

Link: https://dillinger.io n

2. Markable.in

Link: https://markable.in n

3. 簡書

Link: http://www.jianshu.com n

4. 有道雲筆記

Link: https://note.youdao.com n

有道雲筆記裡面加入了一些實用擴展,比如:待辦事項標記、數學公式、圖表等。

Afterword

俗話說,工欲善其事必先利其器,有一個好的工具很重要。但對於寫作來說,養成良好的寫作習慣更重要。畢竟,如果你有強烈而持久的寫作和分享熱情,再簡陋的物質條件也阻止不了你。

給你一支筆,或者一台筆記本,說不定你可以寫遍全世界呢……

最後,以一句話結尾:

Theres a secret that real writers know that wannabe writers dont, and the secret is this: Its not the writing part thats hard. Whats hard is sitting down to write.

- Steven Pressfield, The War of Art

你可能想讀

書單 | 有哪些技術傳播從業者必知必看的書籍?

有哪些適合技術傳播從業者關注的優質博客?

有哪些適合技術傳播從業者關注的優質博客?

技術寫作實例解析 | 簡潔即是美

兩分鐘趣味解讀 Technical Writer

若脫離理解,直譯得再正確又有何意?

優質譯文不應止於正確,還要 Well-Organized

寫在入職技術型創業公司 PingCAP 一個月之後

-END-

推薦閱讀:

聊聊最近越來越火的 ZeroNet
兩件小事:技術小白與程序達人
2018年物聯網十大預測
守住心中的一畝田

TAG:技术 | 写作 | 科技写作 |