markdown常用語(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 的歡迎稿兼使用說(shuō)明,如需撰寫新稿件,點(diǎn)擊頂部工具欄右側(cè)的 <i class="icon-file"></i> 新文稿 或者使用快捷鍵 Ctrl+Alt+N


什么是 Markdown

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

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

  • [ ] 支持以 PDF 格式導(dǎo)出文稿
  • [ ] 改進(jìn) Cmd 渲染算法,使用局部渲染技術(shù)提高渲染效率
  • [x] 新增 Todo 列表功能
  • [x] 修復(fù) LaTex 公式渲染問(wèn)題
  • [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
        測(cè)試          :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ì)語(yǔ)法說(shuō)明

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

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


什么是 Cmd Markdown

您可以使用很多工具書寫 Markdown,但是 Cmd Markdown 是這個(gè)星球上我們已知的、最好的 Markdown 工具——沒有之一 :)因?yàn)樯钚盼淖值牧α浚晕覀兒湍阋粯樱瑢?duì)流暢書寫,分享思想和知識(shí),以及閱讀體驗(yàn)有極致的追求,我們把對(duì)于這些訴求的回應(yīng)整合在 Cmd Markdown,并且一次,兩次,三次,乃至無(wú)數(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 語(yǔ)法的新手,在您完全熟悉它之前,我們?cè)?編輯區(qū) 的頂部放置了一個(gè)如下圖所示的工具欄,您可以使用鼠標(biāo)在工具欄上調(diào)整格式,不過(guò)我們?nèi)耘f鼓勵(lì)你使用鍵盤標(biāo)記格式,提高書寫的流暢度。

tool-editor
tool-editor

3. 編輯模式

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

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

為了保障數(shù)據(jù)安全,Cmd Markdown 會(huì)將您每一次擊鍵的內(nèi)容保存至云端,同時(shí)在 編輯工具欄 的最右側(cè)提示 已保存 的字樣。無(wú)需擔(dān)心瀏覽器崩潰,機(jī)器掉電或者地震,海嘯——在編輯的過(guò)程中隨時(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)閉瀏覽器或者電腦,一樣沒有問(wèn)題,等到下次開啟 Cmd Markdown 的時(shí)候,她會(huì)提醒您將離線保存的文字傳送至云端。簡(jiǎn)而言之,我們盡最大的努力保障您文字的安全。

6. 管理工具欄

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

tool-manager
tool-manager

通過(guò)管理工具欄可以:

<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> 列表:所有新增和過(guò)往的文稿都可以在這里查看、操作
<i class="icon-pencil"></i> 模式:切換 普通/Vim/Emacs 編輯模式

7. 閱讀工具欄

tool-manager
tool-manager

通過(guò) 預(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> 閱讀:心無(wú)旁騖的閱讀模式提供超一流的閱讀體驗(yàn)
<i class="icon-fullscreen"></i> 全屏:簡(jiǎn)潔,簡(jiǎn)潔,再簡(jiǎn)潔,一個(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)鍵字過(guò)濾文稿,如下圖所示:

file-list
file-list

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

在您使用 Cmd Markdown 記錄,創(chuàng)作,整理,閱讀文稿的同時(shí),我們不僅希望它是一個(gè)有力的工具,更希望您的思想和知識(shí)通過(guò)這個(gè)平臺(tái),連同優(yōu)質(zhì)的閱讀體驗(yàn),將他們分享給有相同志趣的人,進(jìn)而鼓勵(lì)更多的人來(lái)到這里記錄分享他們的思想和知識(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) 開始撰寫新的文稿吧!祝您在這里記錄、閱讀、分享愉快!


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

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

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