Markdown 寫作規(guī)范參考


為什么需要規(guī)范

起因-線索1:
看到一篇文章:《寫作指南》茵休,介紹了一些編輯文檔的一些規(guī)范赛惩。這些規(guī)范不一定每個(gè)人都贊同,但是搞旭,我覺得每個(gè)人有一套寫作的規(guī)則散怖,那是很必要的唐断。

起因-線索2:

陽志平的一條微博
陽志平的一條微博

我的評(píng)論
我的評(píng)論

小結(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è)交煞。(還是三個(gè)方便,手敲就行斟或,不用依賴 Emacs 之類編輯器素征。)

中英文之間加空格,用 “湯姆就是 Tom 的音譯”萝挤,而不是“湯姆就是Tom的音譯”御毅。防止專有名詞空一格后的割裂感,比起 “我最愛的產(chǎn)品是簡書和豆瓣 FM”怜珍,我們傾向于使用 “我最愛的產(chǎn)品是簡書和豆瓣FM”端蛆,或者 “我最愛的產(chǎn)品是 簡書 和 豆瓣FM”。

麻煩的是酥泛,這也導(dǎo)致了一個(gè)問題今豆,比如這篇文章(點(diǎn)擊圖片跳轉(zhuǎn))

![][jianshu-bug]

可以看到,有些行被拉伸得面目全非了柔袁。晚凿。。

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 (一些變更記錄)

  1. 斜體和加粗中不再使用 _垦梆,而是用 *匹颤,和 GitHub 同步
  2. 不使用 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;

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市赦肃,隨后出現(xiàn)的幾起案子鼻百,更是在濱河造成了極大的恐慌,老刑警劉巖摆尝,帶你破解...
    沈念sama閱讀 206,602評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異因悲,居然都是意外死亡堕汞,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,442評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門晃琳,熙熙樓的掌柜王于貴愁眉苦臉地迎上來讯检,“玉大人,你說我怎么就攤上這事卫旱∪俗疲” “怎么了?”我有些...
    開封第一講書人閱讀 152,878評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵顾翼,是天一觀的道長投放。 經(jīng)常有香客問我,道長适贸,這世上最難降的妖魔是什么灸芳? 我笑而不...
    開封第一講書人閱讀 55,306評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮拜姿,結(jié)果婚禮上烙样,老公的妹妹穿的比我還像新娘。我一直安慰自己蕊肥,他們只是感情好谒获,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,330評(píng)論 5 373
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著壁却,像睡著了一般批狱。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上展东,一...
    開封第一講書人閱讀 49,071評(píng)論 1 285
  • 那天精耐,我揣著相機(jī)與錄音,去河邊找鬼琅锻。 笑死卦停,一個(gè)胖子當(dāng)著我的面吹牛向胡,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播惊完,決...
    沈念sama閱讀 38,382評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼僵芹,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了小槐?” 一聲冷哼從身側(cè)響起拇派,我...
    開封第一講書人閱讀 37,006評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎凿跳,沒想到半個(gè)月后件豌,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,512評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡控嗜,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,965評(píng)論 2 325
  • 正文 我和宋清朗相戀三年茧彤,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片疆栏。...
    茶點(diǎn)故事閱讀 38,094評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡曾掂,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出壁顶,到底是詐尸還是另有隱情珠洗,我是刑警寧澤,帶...
    沈念sama閱讀 33,732評(píng)論 4 323
  • 正文 年R本政府宣布若专,位于F島的核電站许蓖,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏调衰。R本人自食惡果不足惜蛔糯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,283評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望窖式。 院中可真熱鬧蚁飒,春花似錦、人聲如沸萝喘。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,286評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽阁簸。三九已至爬早,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間启妹,已是汗流浹背筛严。 一陣腳步聲響...
    開封第一講書人閱讀 31,512評(píng)論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留饶米,地道東北人桨啃。 一個(gè)月前我還...
    沈念sama閱讀 45,536評(píng)論 2 354
  • 正文 我出身青樓车胡,卻偏偏與公主長得像,于是被迫代替她去往敵國和親照瘾。 傳聞我的和親對(duì)象是個(gè)殘疾皇子匈棘,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,828評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容