1. 程式人生 > 實用技巧 >Markdown模板

Markdown模板

歡迎使用 Cmd Markdown 編輯閱讀器


我們理解您需要更便捷更高效的工具記錄思想,整理筆記、知識,並將其中承載的價值傳播給他人,Cmd Markdown 是我們給出的答案 —— 我們為記錄思想和分享知識提供更專業的工具。 您可以使用 Cmd Markdown:

  • 整理知識,學習筆記
  • 釋出日記,雜文,所見所想
  • 撰寫釋出技術文稿(程式碼支援)
  • 撰寫釋出學術論文(LaTeX 公式支援)

除了您現在看到的這個 Cmd Markdown 線上版本,您還可以前往以下網址下載:

Windows/Mac/Linux 全平臺客戶端

請保留此份 Cmd Markdown 的歡迎稿兼使用說明,如需撰寫新稿件,點選頂部工具欄右側的

新文稿 或者使用快捷鍵 Ctrl+Alt+N


什麼是 Markdown

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

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

  • [ ] 支援以 PDF 格式匯出文稿
  • [ ] 改進 Cmd 渲染演算法,使用區域性渲染技術提高渲染效率
  • [x] 新增 Todo 列表功能
  • [x] 修復 LaTex 公式渲染問題
  • [x] 新增 LaTex 公式編號功能

2. 書寫一個質能守恆公式[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 專案開發流程
    section 專案確定
        需求分析       :a1, 2016-06-22, 3d
        可行性報告     :after a1, 5d
        概念驗證       : 5d
    section 專案實施
        概要設計      :2016-07-05  , 5d
        詳細設計      :2016-07-08, 10d
        編碼          :2016-07-15, 10d
        測試          :2016-07-22, 5d
    section 釋出驗收
        釋出: 2d
        驗收: 3d

7. 繪製表格

| 專案        | 價格   |  數量  |
| --------   | -----:  | :----:  |
| 計算機     | $1600 |   5     |
| 手機        |   $12   |   12   |
| 管線        |    $1    |  234  |

8. 更詳細語法說明

想要檢視更詳細的語法說明,可以參考我們準備的 Cmd Markdown 簡明語法手冊,進階使用者可以參考 Cmd Markdown 高階語法手冊 瞭解更多高階功能。

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


什麼是 Cmd Markdown

您可以使用很多工具書寫 Markdown,但是 Cmd Markdown 是這個星球上我們已知的、最好的 Markdown 工具——沒有之一 :)因為深信文字的力量,所以我們和你一樣,對流暢書寫,分享思想和知識,以及閱讀體驗有極致的追求,我們把對於這些訴求的迴應整合在 Cmd Markdown,並且一次,兩次,三次,乃至無數次地提升這個工具的體驗,最終將它演化成一個 編輯/釋出/閱讀 Markdown 的線上平臺——您可以在任何地方,任何系統/裝置上管理這裡的文字。

1. 實時同步預覽

我們將 Cmd Markdown 的主介面一分為二,左邊為編輯區,右邊為預覽區,在編輯區的操作會實時地渲染到預覽區方便檢視最終的版面效果,並且如果你在其中一個區拖動滾動條,我們有一個巧妙的演算法把另一個區的滾動條同步到等價的位置,超酷!

2. 編輯工具欄

也許您還是一個 Markdown 語法的新手,在您完全熟悉它之前,我們在 編輯區 的頂部放置了一個如下圖所示的工具欄,您可以使用滑鼠在工具欄上調整格式,不過我們仍舊鼓勵你使用鍵盤標記格式,提高書寫的流暢度。

3. 編輯模式

完全心無旁騖的方式編輯文字:點選 編輯工具欄 最右側的拉伸按鈕或者按下 Ctrl + M,將 Cmd Markdown 切換到獨立的編輯模式,這是一個極度簡潔的寫作環境,所有可能會引起分心的元素都已經被挪除,超清爽!

4. 實時的雲端文稿

為了保障資料安全,Cmd Markdown 會將您每一次擊鍵的內容儲存至雲端,同時在 編輯工具欄 的最右側提示 已儲存 的字樣。無需擔心瀏覽器崩潰,機器掉電或者地震,海嘯——在編輯的過程中隨時關閉瀏覽器或者機器,下一次回到 Cmd Markdown 的時候繼續寫作。

5. 離線模式

在網路環境不穩定的情況下記錄文字一樣很安全!在您寫作的時候,如果電腦突然失去網路連線,Cmd Markdown 會智慧切換至離線模式,將您後續鍵入的文字儲存在本地,直到網路恢復再將他們傳送至雲端,即使在網路恢復前關閉瀏覽器或者電腦,一樣沒有問題,等到下次開啟 Cmd Markdown 的時候,她會提醒您將離線儲存的文字傳送至雲端。簡而言之,我們盡最大的努力保障您文字的安全。

6. 管理工具欄

為了便於管理您的文稿,在 預覽區 的頂部放置瞭如下所示的 管理工具欄

通過管理工具欄可以:

釋出:將當前的文稿生成固定連結,在網路上釋出,分享
新建:開始撰寫一篇新的文稿
刪除:刪除當前的文稿
匯出:將當前的文稿轉化為 Markdown 文字或者 Html 格式,並匯出到本地
列表:所有新增和過往的文稿都可以在這裡檢視、操作
模式:切換 普通/Vim/Emacs 編輯模式

7. 閱讀工具欄

通過 預覽區 右上角的 閱讀工具欄,可以檢視當前文稿的目錄並增強閱讀體驗。

工具欄上的五個圖示依次為:

目錄:快速導航當前文稿的目錄結構以跳轉到感興趣的段落
檢視:互換左邊編輯區和右邊預覽區的位置
主題:內建了黑白兩種模式的主題,試試 黑色主題,超炫!
閱讀:心無旁騖的閱讀模式提供超一流的閱讀體驗
全屏:簡潔,簡潔,再簡潔,一個完全沉浸式的寫作和閱讀環境

8. 閱讀模式

閱讀工具欄 點選 或者按下 Ctrl+Alt+M 隨即進入獨立的閱讀模式介面,我們在版面渲染上的每一個細節:字型,字號,行間距,前背景色都傾注了大量的時間,努力提升閱讀的體驗和品質。

9. 標籤、分類和搜尋

在編輯區任意行首位置輸入以下格式的文字可以標籤當前文件:

標籤: 未分類

標籤以後的文稿在【檔案列表】(Ctrl+Alt+F)裡會按照標籤分類,使用者可以同時使用鍵盤或者滑鼠瀏覽檢視,或者在【檔案列表】的搜尋文字框內搜尋標題關鍵字過濾文稿,如下圖所示:

10. 文稿釋出和分享

在您使用 Cmd Markdown 記錄,創作,整理,閱讀文稿的同時,我們不僅希望它是一個有力的工具,更希望您的思想和知識通過這個平臺,連同優質的閱讀體驗,將他們分享給有相同志趣的人,進而鼓勵更多的人來到這裡記錄分享他們的思想和知識,嘗試點選 (Ctrl+Alt+P) 釋出這份文件給好友吧!


再一次感謝您花費時間閱讀這份歡迎稿,點選 (Ctrl+Alt+N) 開始撰寫新的文稿吧!祝您在這裡記錄、閱讀、分享愉快!

作者 @ghosert     
2016 年 07月 07日


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

  2. 程式碼高亮功能支援包括 Java, Python, JavaScript 在內的,四十一種主流程式語言。 ↩︎