為什么需要規范
起因-線索1:
看到一篇文章:《寫作指南》,介紹了一些編輯文檔的一些規范。這些規范不一定每個人都贊同,但是,我覺得每個人有一套寫作的規則,那是很必要的。
起因-線索2:
小結:
使用 Markdown 寫作也需要一定的規范。它不僅是一種風格,還可以避免不必要的糾結(不要做布里丹的驢子)。如果你每次都糾結于吃香草冰激凌還是巧克力冰激淋,我的建議是:對自己說,以后我只選香草的!
最后,規范無所謂對錯,選擇自己喜歡的并堅持施行就好。
我的 Markdown 規范
Markdown 有一套輕量級的標記規則,但我看來還是它還不夠簡潔,比如加粗你可以 **粗體**
,或者 __粗體__
,這給使用者帶來了完全沒有必要的多選一的麻煩。
所以這里的 Markdown 規范實質上就是對過多的同樣功能的實現進行精簡。
1. 加粗
使用 **加粗**
,而不是 __加粗__
2. 斜體
使用 *斜體*
,而不是 _斜體_
3. 加粗并斜體
使用 ***粗斜***
,而不是 **_粗斜_**
等
4. 鏈接
段落內使用 [Text][url]
,左右各空一格。不使用 [Text](url)
,它會使段落看起來臃腫(鏈接通常都很長)
除非當你有很多鏈接(一個列表),可能甚至還需要排序的時候。
比如 這篇文章 最后的文章列表。源碼 Sample:
1. [15個你不知道的殺手級Google Chrome功能 | 簡書](http://jianshu.io/p/oapzzC)
* [1. Mac OS 環境下的辦公應用程序 | 簡書](http://jianshu.io/p/371f1646cbc7)
* [GTD噩夢 | 簡書](http://jianshu.io/p/c1091837e0ba)
* [GTD的一點學習心得 | 簡書](http://jianshu.io/p/3pCFzt)
* [Mac付費軟件推薦與打折信息 | 簡書](http://jianshu.io/p/0a75f86720cd)
5. 鏈接 url 放在哪?
比如你有這樣一個段落:
這是一個帶有[超鏈接][link-to]的段落。
你的 [link-to]: url
放在哪?緊跟段落后面,還是一大章節后面,還是全文最后?
我的建議是盡量放在章節后。比如放在下一個四級標題 ####
前。
6. 空格、空行、分隔符
通常我在 #### 一個小節
前留多個空行,后面加一個空行再開始小節內容。
段落不縮進兩個字符。段落之間留一個空行。
在應該分割的地方,Markdown 支持用一個空行加 ---
(可以更多個-
) 形成一個<hr>
(分割符)。但基于視覺上的考慮我使用整 80 個 (還是三個方便,手敲就行,不用依賴 Emacs 之類編輯器。)-
,而不是三個。
中英文之間加空格,用 “湯姆就是 Tom 的音譯”,而不是“湯姆就是Tom的音譯”。防止專有名詞空一格后的割裂感,比起 “我最愛的產品是簡書和豆瓣 FM”,我們傾向于使用 “我最愛的產品是簡書和豆瓣FM”,或者 “我最愛的產品是 簡書 和 豆瓣FM”。
麻煩的是,這也導致了一個問題,比如這篇文章(點擊圖片跳轉)
可以看到,有些行被拉伸得面目全非了。。。
Donald Knuth 在他的 The TeXbook 里就批評過:
我覺得這是簡書的 Bug
7. Headers
h1 標題,兩種方式選一種
# 這是文章標題
這也是文章標題
=========
h2 Section,兩種方式選一種
## 雙塔奇兵
雙塔奇兵
-------
h3 Chapter
### Chapter 3
h4, h5, h6,你隨意 ==
8. 雜項
單行長文字。(在兩個~~~
行之間添加內容。)
簡書筆記是定位于寫作者的一款寫作軟件,界面非常簡潔,其最大的特色是支持 Markdown 功能,希望為作者制造出一種沉浸式的寫作氛圍,進而可以專注于寫作。簡書還支持寫作模式,在簡書·筆記中打開寫作模式即可讓撰寫窗全屏化,再配合 Chrome 等瀏覽器的全屏瀏覽功能。簡書·筆記能夠達到與 Q10、MTW 之類的專心致志寫作軟件同樣的效果。
這也是我所有文章末尾加 log
的方式。
歡迎補充。歡迎討論。
附:規范 Roadmap (一些變更記錄)
- 斜體和加粗中不再使用
_
,而是用*
,和 GitHub 同步 - 不使用 80 個
-
,簡單處理,使用 3 個就夠了
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,修改了一些規范,加入了 Roadmap; $5. Tue Jan 20 18:58:50 CST 2015;