MarkDown指南

傳送門娱据,請(qǐng)點(diǎn)擊右邊q查看 --> sf里編寫的我覺得不錯(cuò)的MarkDown使用指南
個(gè)人覺得簡書MarkDown官方教程里的寫得很簡潔,基本上看完就能開始用上MD了苟跪,但是sf里的這個(gè)教程對(duì)于編寫代碼較多的內(nèi)容會(huì)更受用些侵俗。

以下示例來自于作業(yè)部落的MarkDown官方使用說明


我們理解您需要更便捷更高效的工具記錄思想殿较,整理筆記、知識(shí)澜躺,并將其中承載的價(jià)值傳播給他人蝉稳,Cmd Markdown 是我們給出的答案 —— 我們?yōu)橛涗浰枷牒头窒碇R(shí)提供更專業(yè)的工具抒蚜。 您可以使用 Cmd Markdown:

  • 整理知識(shí),學(xué)習(xí)筆記
  • 發(fā)布日記耘戚,雜文嗡髓,所見所想
  • 撰寫發(fā)布技術(shù)文稿(代碼支持)
  • 撰寫發(fā)布學(xué)術(shù)論文(LaTeX 公式支持)
cmd-markdown-logo
cmd-markdown-logo

除了您現(xiàn)在看到的這個(gè) Cmd Markdown 在線版本,您還可以前往以下網(wǎng)址下載:

Windows/Mac/Linux 全平臺(tái)客戶端

請(qǐng)保留此份 Cmd Markdown 的歡迎稿兼使用說明收津,如需撰寫新稿件饿这,點(diǎn)擊頂部工具欄右側(cè)的 <i class="icon-file"></i> 新文稿 或者使用快捷鍵 Ctrl+Alt+N


什么是 Markdown

Markdown 是一種方便記憶撞秋、書寫的純文本標(biāo)記語言长捧,用戶可以使用這些標(biāo)記符號(hào)以最小的輸入代價(jià)生成極富表現(xiàn)力的文檔:譬如您正在閱讀的這份文檔。它使用簡單的符號(hào)標(biāo)記不同的標(biāo)題吻贿,分割不同的段落串结,粗體 或者 斜體 某些文字,更棒的是廓八,它還可以

1. 制作一份待辦事宜 Todo 列表

  • [ ] 支持以 PDF 格式導(dǎo)出文稿
  • [ ] 改進(jìn) Cmd 渲染算法奉芦,使用局部渲染技術(shù)提高渲染效率
  • [x] 新增 Todo 列表功能
  • [x] 修復(fù) LaTex 公式渲染問題
  • [x] 新增 LaTex 公式編號(hào)功能

2. 書寫一個(gè)質(zhì)能守恒公式[1]

$$E=mc^2$$

3. 高亮一段代碼[2]

@requires_authorization
class SomeClass:
    pass

if __name__ == '__main__':
    # A comment
    print 'hello world'

4. 高效繪制 流程圖

st=>start: Start
op=>operation: Your Operation
cond=>condition: Yes or No?
e=>end

st->op->cond
cond(yes)->e
cond(no)->op

5. 高效繪制 序列圖

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

6. 高效繪制 甘特圖

    title 項(xiàng)目開發(fā)流程
    section 項(xiàng)目確定
        需求分析       :a1, 2016-06-22, 3d
        可行性報(bào)告     :after a1, 5d
        概念驗(yàn)證       : 5d
    section 項(xiàng)目實(shí)施
        概要設(shè)計(jì)      :2016-07-05  , 5d
        詳細(xì)設(shè)計(jì)      :2016-07-08, 10d
        編碼          :2016-07-15, 10d
        測試          :2016-07-22, 5d
    section 發(fā)布驗(yàn)收
        發(fā)布: 2d
        驗(yàn)收: 3d

7. 繪制表格

項(xiàng)目 價(jià)格 數(shù)量
計(jì)算機(jī) $1600 5
手機(jī) $12 12
管線 $1 234

8. 更詳細(xì)語法說明

想要查看更詳細(xì)的語法說明,可以參考我們準(zhǔn)備的 Cmd Markdown 簡明語法手冊(cè)剧蹂,進(jìn)階用戶可以參考 Cmd Markdown 高階語法手冊(cè) 了解更多高級(jí)功能声功。

總而言之,不同于其它 所見即所得 的編輯器:你只需使用鍵盤專注于書寫文本內(nèi)容宠叼,就可以生成印刷級(jí)的排版格式先巴,省卻在鍵盤和工具欄之間來回切換,調(diào)整內(nèi)容和格式的麻煩冒冬。Markdown 在流暢的書寫和印刷級(jí)的閱讀體驗(yàn)之間找到了平衡伸蚯。 目前它已經(jīng)成為世界上最大的技術(shù)分享網(wǎng)站 GitHub 和 技術(shù)問答網(wǎng)站 StackOverFlow 的御用書寫格式。


什么是 Cmd Markdown

您可以使用很多工具書寫 Markdown简烤,但是 Cmd Markdown 是這個(gè)星球上我們已知的剂邮、最好的 Markdown 工具——沒有之一 :)因?yàn)樯钚盼淖值牧α浚晕覀兒湍阋粯雍嵴欤瑢?duì)流暢書寫挥萌,分享思想和知識(shí),以及閱讀體驗(yàn)有極致的追求枉侧,我們把對(duì)于這些訴求的回應(yīng)整合在 Cmd Markdown引瀑,并且一次,兩次榨馁,三次憨栽,乃至無數(shù)次地提升這個(gè)工具的體驗(yàn),最終將它演化成一個(gè) 編輯/發(fā)布/閱讀 Markdown 的在線平臺(tái)——您可以在任何地方,任何系統(tǒng)/設(shè)備上管理這里的文字屑柔。

1. 實(shí)時(shí)同步預(yù)覽

我們將 Cmd Markdown 的主界面一分為二屡萤,左邊為編輯區(qū),右邊為預(yù)覽區(qū)锯蛀,在編輯區(qū)的操作會(huì)實(shí)時(shí)地渲染到預(yù)覽區(qū)方便查看最終的版面效果灭衷,并且如果你在其中一個(gè)區(qū)拖動(dòng)滾動(dòng)條,我們有一個(gè)巧妙的算法把另一個(gè)區(qū)的滾動(dòng)條同步到等價(jià)的位置旁涤,超酷翔曲!

2. 編輯工具欄

也許您還是一個(gè) Markdown 語法的新手,在您完全熟悉它之前劈愚,我們?cè)?編輯區(qū) 的頂部放置了一個(gè)如下圖所示的工具欄瞳遍,您可以使用鼠標(biāo)在工具欄上調(diào)整格式,不過我們?nèi)耘f鼓勵(lì)你使用鍵盤標(biāo)記格式菌羽,提高書寫的流暢度掠械。

tool-editor
tool-editor

3. 編輯模式

完全心無旁騖的方式編輯文字:點(diǎn)擊 編輯工具欄 最右側(cè)的拉伸按鈕或者按下 Ctrl + M,將 Cmd Markdown 切換到獨(dú)立的編輯模式注祖,這是一個(gè)極度簡潔的寫作環(huán)境猾蒂,所有可能會(huì)引起分心的元素都已經(jīng)被挪除,超清爽是晨!

4. 實(shí)時(shí)的云端文稿

為了保障數(shù)據(jù)安全肚菠,Cmd Markdown 會(huì)將您每一次擊鍵的內(nèi)容保存至云端,同時(shí)在 編輯工具欄 的最右側(cè)提示 已保存 的字樣罩缴。無需擔(dān)心瀏覽器崩潰蚊逢,機(jī)器掉電或者地震,海嘯——在編輯的過程中隨時(shí)關(guān)閉瀏覽器或者機(jī)器箫章,下一次回到 Cmd Markdown 的時(shí)候繼續(xù)寫作烙荷。

5. 離線模式

在網(wǎng)絡(luò)環(huán)境不穩(wěn)定的情況下記錄文字一樣很安全!在您寫作的時(shí)候檬寂,如果電腦突然失去網(wǎng)絡(luò)連接终抽,Cmd Markdown 會(huì)智能切換至離線模式,將您后續(xù)鍵入的文字保存在本地桶至,直到網(wǎng)絡(luò)恢復(fù)再將他們傳送至云端拿诸,即使在網(wǎng)絡(luò)恢復(fù)前關(guān)閉瀏覽器或者電腦,一樣沒有問題塞茅,等到下次開啟 Cmd Markdown 的時(shí)候,她會(huì)提醒您將離線保存的文字傳送至云端季率。簡而言之野瘦,我們盡最大的努力保障您文字的安全。

6. 管理工具欄

為了便于管理您的文稿,在 預(yù)覽區(qū) 的頂部放置了如下所示的 管理工具欄

tool-manager
tool-manager

通過管理工具欄可以:

<i class="icon-share"></i> 發(fā)布:將當(dāng)前的文稿生成固定鏈接鞭光,在網(wǎng)絡(luò)上發(fā)布吏廉,分享
<i class="icon-file"></i> 新建:開始撰寫一篇新的文稿
<i class="icon-trash"></i> 刪除:刪除當(dāng)前的文稿
<i class="icon-cloud"></i> 導(dǎo)出:將當(dāng)前的文稿轉(zhuǎn)化為 Markdown 文本或者 Html 格式,并導(dǎo)出到本地
<i class="icon-reorder"></i> 列表:所有新增和過往的文稿都可以在這里查看惰许、操作
<i class="icon-pencil"></i> 模式:切換 普通/Vim/Emacs 編輯模式

7. 閱讀工具欄

tool-manager
tool-manager

通過 預(yù)覽區(qū) 右上角的 閱讀工具欄席覆,可以查看當(dāng)前文稿的目錄并增強(qiáng)閱讀體驗(yàn)。

工具欄上的五個(gè)圖標(biāo)依次為:

<i class="icon-list"></i> 目錄:快速導(dǎo)航當(dāng)前文稿的目錄結(jié)構(gòu)以跳轉(zhuǎn)到感興趣的段落
<i class="icon-chevron-sign-left"></i> 視圖:互換左邊編輯區(qū)和右邊預(yù)覽區(qū)的位置
<i class="icon-adjust"></i> 主題:內(nèi)置了黑白兩種模式的主題汹买,試試 黑色主題佩伤,超炫!
<i class="icon-desktop"></i> 閱讀:心無旁騖的閱讀模式提供超一流的閱讀體驗(yàn)
<i class="icon-fullscreen"></i> 全屏:簡潔晦毙,簡潔生巡,再簡潔,一個(gè)完全沉浸式的寫作和閱讀環(huán)境

8. 閱讀模式

閱讀工具欄 點(diǎn)擊 <i class="icon-desktop"></i> 或者按下 Ctrl+Alt+M 隨即進(jìn)入獨(dú)立的閱讀模式界面见妒,我們?cè)诎婷驿秩旧系拿恳粋€(gè)細(xì)節(jié):字體孤荣,字號(hào),行間距须揣,前背景色都傾注了大量的時(shí)間盐股,努力提升閱讀的體驗(yàn)和品質(zhì)。

9. 標(biāo)簽耻卡、分類和搜索

在編輯區(qū)任意行首位置輸入以下格式的文字可以標(biāo)簽當(dāng)前文檔:

標(biāo)簽: 未分類

標(biāo)簽以后的文稿在【文件列表】(Ctrl+Alt+F)里會(huì)按照標(biāo)簽分類疯汁,用戶可以同時(shí)使用鍵盤或者鼠標(biāo)瀏覽查看,或者在【文件列表】的搜索文本框內(nèi)搜索標(biāo)題關(guān)鍵字過濾文稿劲赠,如下圖所示:

file-list
file-list

10. 文稿發(fā)布和分享

在您使用 Cmd Markdown 記錄涛目,創(chuàng)作,整理凛澎,閱讀文稿的同時(shí)霹肝,我們不僅希望它是一個(gè)有力的工具,更希望您的思想和知識(shí)通過這個(gè)平臺(tái)塑煎,連同優(yōu)質(zhì)的閱讀體驗(yàn)沫换,將他們分享給有相同志趣的人,進(jìn)而鼓勵(lì)更多的人來到這里記錄分享他們的思想和知識(shí)最铁,嘗試點(diǎn)擊 <i class="icon-share"></i> (Ctrl+Alt+P) 發(fā)布這份文檔給好友吧讯赏!


再一次感謝您花費(fèi)時(shí)間閱讀這份歡迎稿,點(diǎn)擊 <i class="icon-file"></i> (Ctrl+Alt+N) 開始撰寫新的文稿吧冷尉!祝您在這里記錄漱挎、閱讀、分享愉快雀哨!

作者 @ghosert
2016 年 07月 07日


  1. 支持 LaTeX 編輯顯示支持磕谅,例如:$\sum_{i=1}^n a_i=0$私爷, 訪問 MathJax 參考更多使用方法。 ?

  2. 代碼高亮功能支持包括 Java, Python, JavaScript 在內(nèi)的膊夹,四十一種主流編程語言衬浑。 ?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市放刨,隨后出現(xiàn)的幾起案子工秩,更是在濱河造成了極大的恐慌,老刑警劉巖进统,帶你破解...
    沈念sama閱讀 212,332評(píng)論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件助币,死亡現(xiàn)場離奇詭異,居然都是意外死亡麻昼,警方通過查閱死者的電腦和手機(jī)奠支,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,508評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來抚芦,“玉大人倍谜,你說我怎么就攤上這事〔媛眨” “怎么了尔崔?”我有些...
    開封第一講書人閱讀 157,812評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長褥民。 經(jīng)常有香客問我季春,道長,這世上最難降的妖魔是什么消返? 我笑而不...
    開封第一講書人閱讀 56,607評(píng)論 1 284
  • 正文 為了忘掉前任载弄,我火速辦了婚禮,結(jié)果婚禮上撵颊,老公的妹妹穿的比我還像新娘宇攻。我一直安慰自己,他們只是感情好倡勇,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,728評(píng)論 6 386
  • 文/花漫 我一把揭開白布逞刷。 她就那樣靜靜地躺著,像睡著了一般妻熊。 火紅的嫁衣襯著肌膚如雪夸浅。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,919評(píng)論 1 290
  • 那天扔役,我揣著相機(jī)與錄音帆喇,去河邊找鬼。 笑死亿胸,一個(gè)胖子當(dāng)著我的面吹牛坯钦,可吹牛的內(nèi)容都是我干的法严。 我是一名探鬼主播,決...
    沈念sama閱讀 39,071評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼葫笼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了拗馒?” 一聲冷哼從身側(cè)響起路星,我...
    開封第一講書人閱讀 37,802評(píng)論 0 268
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎诱桂,沒想到半個(gè)月后洋丐,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,256評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡挥等,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,576評(píng)論 2 327
  • 正文 我和宋清朗相戀三年友绝,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片肝劲。...
    茶點(diǎn)故事閱讀 38,712評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡迁客,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出辞槐,到底是詐尸還是另有隱情掷漱,我是刑警寧澤,帶...
    沈念sama閱讀 34,389評(píng)論 4 332
  • 正文 年R本政府宣布榄檬,位于F島的核電站卜范,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏鹿榜。R本人自食惡果不足惜海雪,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,032評(píng)論 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望舱殿。 院中可真熱鬧奥裸,春花似錦、人聲如沸怀薛。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,798評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽枝恋。三九已至创倔,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間焚碌,已是汗流浹背畦攘。 一陣腳步聲響...
    開封第一講書人閱讀 32,026評(píng)論 1 266
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留十电,地道東北人知押。 一個(gè)月前我還...
    沈念sama閱讀 46,473評(píng)論 2 360
  • 正文 我出身青樓叹螟,卻偏偏與公主長得像,于是被迫代替她去往敵國和親台盯。 傳聞我的和親對(duì)象是個(gè)殘疾皇子罢绽,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,606評(píng)論 2 350

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