Markdown:寫技術(shù)文檔、個(gè)人博客和讀書筆記都很好用的輕量級(jí)標(biāo)記語言

Foreword

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

Markdown 是什么?

Markdown 是一種輕量級(jí)標(biāo)記語言,這個(gè)語言的目的是希望大家使用“易于閱讀、易于撰寫的純文字格式,并選擇性的轉(zhuǎn)換成有效的 XHTML(或是 HTML)”。

Markdown 既可以用來寫產(chǎn)品的中英文技術(shù)文檔、使用說明,也可以用來寫個(gè)人博客。許多網(wǎng)站都使用 Markdown 或是其變種,例如 GitHub、reddit、簡書。

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

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

Aaron Swartz 出生于 1986 年,可謂互聯(lián)網(wǎng)界的奇才,可惜 2013 年便自殺身亡,英年早逝。2014 年上映的記錄片《互聯(lián)網(wǎng)之子》記錄了他短暫但輝煌的一生。紀(jì)錄片英文名為:The Internet's Own Boy: The Story of Aaron Swartz

該紀(jì)錄片豆瓣評(píng)分 9.1,強(qiáng)烈推薦。

Markdown 語法有多簡單?

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

1. 標(biāo)題

通過輸入特定數(shù)量的井號(hào) "#" 即可實(shí)現(xiàn)不同級(jí)別的標(biāo)題:

# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題

顯示效果如下:

一級(jí)標(biāo)題

二級(jí)標(biāo)題

三級(jí)標(biāo)題

四級(jí)標(biāo)題


2. 列表

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

無序列表使用星號(hào)、加號(hào)或是減號(hào)均可實(shí)現(xiàn)。例如:

* PingCAP
* TiDB
* TiKV

效果等同于:

+ PingCAP
+ TiDB
+ TiDB

還等同于:

- PingCAP
- TiDB
- TiKV

有序列表使用數(shù)字接一個(gè)英文句點(diǎn)即可實(shí)現(xiàn)。例如:

1. PingCAP
2. TiDB
3. Database

顯示效果如下:


3. 鏈接

行內(nèi)鏈接實(shí)現(xiàn)方式:[鏈接文字](鏈接地址)。例如:

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

顯示效果如下:

PingCAP · GitHub

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


4. 強(qiáng)調(diào)

Markdown 使用星號(hào) "*" 和底線 "_" 來實(shí)現(xiàn)強(qiáng)調(diào)效果。例如:

# 前兩個(gè)顯示為斜體效果

*TiDB*

_TiDB_

# 后兩個(gè)顯示為加粗效果

**TiDB**

__TiDB__

顯示效果如下:

TiDB

TiDB

TiDB

TiDB


5. 其它

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

有哪些 Markdown 編輯器?

Markdown 編輯器有很多,這里介紹幾種 Mac 平臺(tái)、Windows 平臺(tái)適用的編輯器和在線編輯器。大家可以試用一下,看看自己鐘愛哪款。

Mac 平臺(tái)

1. MacDown


2. Typora

同樣適用 Windows 平臺(tái)

3. Ulysses

4. Mou

Windows 平臺(tái)

1. MarkdownPad

2. Typora

在線編輯器

1. Dillinger.io

Link: https://dillinger.io

2. Markable.in

Link: https://markable.in

3. 簡書

Link: http://m.itdecent.cn

4. 有道云筆記

Link: https://note.youdao.com

有道云筆記里面加入了一些實(shí)用擴(kuò)展,比如:待辦事項(xiàng)標(biāo)記、數(shù)學(xué)公式、圖表等。

Afterword

俗話說,工欲善其事必先利其器,有一個(gè)好的工具很重要。但對(duì)于寫作來說,養(yǎng)成良好的寫作習(xí)慣更重要。畢竟,如果你有強(qiáng)烈而持久的寫作和分享熱情,再簡陋的物質(zhì)條件也阻止不了你。

給你一支筆,或者一臺(tái)筆記本,說不定你可以寫遍全世界呢……

最后,以一句話結(jié)尾:

There's a secret that real writers know that wannabe writers don't, and the secret is this: It's not the writing part that's hard. What's hard is sitting down to write. - Steven Pressfield, The War of Art

你可能想讀
書單 | 有哪些技術(shù)傳播從業(yè)者必知必看的書籍?
有哪些適合技術(shù)傳播從業(yè)者關(guān)注的優(yōu)質(zhì)博客?
技術(shù)寫作實(shí)例解析 | 簡潔即是美
兩分鐘趣味解讀 Technical Writer
若脫離理解,直譯得再正確又有何意?
優(yōu)質(zhì)譯文不應(yīng)止于正確,還要 Well-Organized
寫在入職技術(shù)型創(chuàng)業(yè)公司 PingCAP 一個(gè)月之后

-END-

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容