為什么需要規(guī)范
起因-線索1:
看到一篇文章:《寫作指南》茵休,介紹了一些編輯文檔的一些規(guī)范赛惩。這些規(guī)范不一定每個(gè)人都贊同,但是搞旭,我覺得每個(gè)人有一套寫作的規(guī)則散怖,那是很必要的唐断。
起因-線索2:
小結(jié):
使用 Markdown 寫作也需要一定的規(guī)范。它不僅是一種風(fēng)格杭抠,還可以避免不必要的糾結(jié)(不要做布里丹的驢子)。如果你每次都糾結(jié)于吃香草冰激凌還是巧克力冰激淋恳啥,我的建議是:對(duì)自己說偏灿,以后我只選香草的!
最后钝的,規(guī)范無所謂對(duì)錯(cuò)翁垂,選擇自己喜歡的并堅(jiān)持施行就好。
我的 Markdown 規(guī)范
Markdown 有一套輕量級(jí)的標(biāo)記規(guī)則硝桩,但我看來還是它還不夠簡潔沿猜,比如加粗你可以 **粗體**
,或者 __粗體__
碗脊,這給使用者帶來了完全沒有必要的多選一的麻煩啼肩。
所以這里的 Markdown 規(guī)范實(shí)質(zhì)上就是對(duì)過多的同樣功能的實(shí)現(xiàn)進(jìn)行精簡。
1. 加粗
使用 **加粗**
衙伶,而不是 __加粗__
2. 斜體
使用 *斜體*
祈坠,而不是 _斜體_
3. 加粗并斜體
使用 ***粗斜***
,而不是 **_粗斜_**
等
4. 鏈接
段落內(nèi)使用 [Text][url]
矢劲,左右各空一格赦拘。不使用 [Text](url)
,它會(huì)使段落看起來臃腫(鏈接通常都很長)
除非當(dāng)你有很多鏈接(一個(gè)列表)芬沉,可能甚至還需要排序的時(shí)候躺同。
比如 這篇文章 最后的文章列表。源碼 Sample:
1. [15個(gè)你不知道的殺手級(jí)Google Chrome功能 | 簡書](http://jianshu.io/p/oapzzC)
* [1. Mac OS 環(huán)境下的辦公應(yīng)用程序 | 簡書](http://jianshu.io/p/371f1646cbc7)
* [GTD噩夢(mèng) | 簡書](http://jianshu.io/p/c1091837e0ba)
* [GTD的一點(diǎn)學(xué)習(xí)心得 | 簡書](http://jianshu.io/p/3pCFzt)
* [Mac付費(fèi)軟件推薦與打折信息 | 簡書](http://jianshu.io/p/0a75f86720cd)
5. 鏈接 url 放在哪丸逸?
比如你有這樣一個(gè)段落:
這是一個(gè)帶有[超鏈接][link-to]的段落蹋艺。
你的 [link-to]: url
放在哪?緊跟段落后面椭员,還是一大章節(jié)后面车海,還是全文最后?
我的建議是盡量放在章節(jié)后隘击。比如放在下一個(gè)四級(jí)標(biāo)題 ####
前侍芝。
6. 空格、空行埋同、分隔符
通常我在 #### 一個(gè)小節(jié)
前留多個(gè)空行州叠,后面加一個(gè)空行再開始小節(jié)內(nèi)容。
段落不縮進(jìn)兩個(gè)字符凶赁。段落之間留一個(gè)空行咧栗。
在應(yīng)該分割的地方逆甜,Markdown 支持用一個(gè)空行加 ---
(可以更多個(gè)-
) 形成一個(gè)<hr>
(分割符)。但基于視覺上的考慮我使用整 80 個(gè) (還是三個(gè)方便,手敲就行斟或,不用依賴 Emacs 之類編輯器素征。)-
致板,而不是三個(gè)交煞。
中英文之間加空格,用 “湯姆就是 Tom 的音譯”萝挤,而不是“湯姆就是Tom的音譯”御毅。防止專有名詞空一格后的割裂感,比起 “我最愛的產(chǎn)品是簡書和豆瓣 FM”怜珍,我們傾向于使用 “我最愛的產(chǎn)品是簡書和豆瓣FM”端蛆,或者 “我最愛的產(chǎn)品是 簡書 和 豆瓣FM”。
麻煩的是酥泛,這也導(dǎo)致了一個(gè)問題今豆,比如這篇文章(點(diǎn)擊圖片跳轉(zhuǎn))
可以看到,有些行被拉伸得面目全非了柔袁。晚凿。。
Donald Knuth 在他的 The TeXbook 里就批評(píng)過:
我覺得這是簡書的 Bug
7. Headers
h1 標(biāo)題瘦馍,兩種方式選一種
# 這是文章標(biāo)題
這也是文章標(biāo)題
=========
h2 Section歼秽,兩種方式選一種
## 雙塔奇兵
雙塔奇兵
-------
h3 Chapter
### Chapter 3
h4, h5, h6,你隨意 ==
8. 雜項(xiàng)
單行長文字情组。(在兩個(gè)~~~
行之間添加內(nèi)容燥筷。)
簡書筆記是定位于寫作者的一款寫作軟件,界面非常簡潔院崇,其最大的特色是支持 Markdown 功能肆氓,希望為作者制造出一種沉浸式的寫作氛圍,進(jìn)而可以專注于寫作底瓣。簡書還支持寫作模式谢揪,在簡書·筆記中打開寫作模式即可讓撰寫窗全屏化,再配合 Chrome 等瀏覽器的全屏瀏覽功能捐凭。簡書·筆記能夠達(dá)到與 Q10拨扶、MTW 之類的專心致志寫作軟件同樣的效果。
這也是我所有文章末尾加 log
的方式茁肠。
歡迎補(bǔ)充患民。歡迎討論。
附:規(guī)范 Roadmap (一些變更記錄)
- 斜體和加粗中不再使用
_
垦梆,而是用*
匹颤,和 GitHub 同步 - 不使用 80 個(gè)
-
仅孩,簡單處理,使用 3 個(gè)就夠了
log: $1. 2014-07-05; $2. Thu Jul 17 09:40:04 2014; $3. Wed Aug 6 15:26:10 2014, Fixed Link; $4. Wed Aug 13 17:22:34 2014印蓖,修改了一些規(guī)范辽慕,加入了 Roadmap; $5. Tue Jan 20 18:58:50 CST 2015;