Cmd Markdown 簡明語法手冊

Cmd Markdown 簡明語法手冊

標簽: Cmd-Markdown


1. 斜體和粗體

使用 * 和 ** 表示斜體和粗體。

示例:

這是 斜體,這是 粗體

2. 分級標題

使用 === 表示一級標題,使用 --- 表示二級標題。

示例:

這是一個一級標題
============================

這是一個二級標題
--------------------------------------------------

### 這是一個三級標題

你也可以選擇在行首加井號表示不同級別的標題 (H1-H6),例如:# H1, ## H2, ### H3,#### H4。

3. 外鏈接

使用 [描述](鏈接地址) 為文字增加外鏈接。

示例:

這是去往 本人博客 的鏈接。

4. 無序列表

使用 *,+,- 表示無序列表。

示例:

  • 無序列表項 一
  • 無序列表項 二
  • 無序列表項 三

5. 有序列表

使用數字和點表示有序列表。

示例:

  1. 有序列表項 一
  2. 有序列表項 二
  3. 有序列表項 三

6. 文字引用

使用 > 表示文字引用。

示例:

野火燒不盡,春風吹又生。

7. 行內代碼塊

使用 `代碼` 表示行內代碼塊。

示例:

讓我們聊聊 html

8. 代碼塊

使用 四個縮進空格 表示代碼塊。

示例:

這是一個代碼塊,此行左側有四個不可見的空格。

9. 插入圖像

使用 ![描述](圖片鏈接地址) 插入圖像。

示例:

我的頭像

Cmd Markdown 高階語法手冊

1. 內容目錄

在段落中填寫 [TOC] 以顯示全文內容的目錄結構。

[TOC]

2. 標簽分類

在編輯區任意行的列首位置輸入以下代碼給文稿標簽:

標簽: 數學 英語 Markdown

或者

Tags: 數學 英語 Markdown

3. 刪除線

使用 ~~ 表示刪除線。

這是一段錯誤的文本。

4. 注腳

使用 [^keyword] 表示注腳。

這是一個注腳[1]的樣例。

這是第二個注腳[2]的樣例。

5. LaTeX 公式

$ 表示行內公式:

質能守恒方程可以用一個很簡潔的方程式 $E=mc^2$ 來表達。

$$ 表示整行公式:

$$\sum_{i=1}^n a_i=0$$

$$f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $$

$$\sum^{j-1}{k=0}{\widehat{\gamma}{kj} z_k}$$

訪問 MathJax 參考更多使用方法。

6. 加強的代碼塊

支持四十一種編程語言的語法高亮的顯示,行號顯示。

非代碼示例:

$ sudo apt-get install vim-gnome

Python 示例:

@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None

class SomeClass:
    pass

>>> message = '''interpreter
... prompt'''

JavaScript 示例:

/**
* nth element in the fibonacci series.
* @param n >= 0
* @return the nth element, >= 0.
*/
function fib(n) {
  var a = 1, b = 1;
  var tmp;
  while (--n >= 0) {
    tmp = a;
    a += b;
    b = tmp;
  }
  return a;
}

document.write(fib(10));

7. 流程圖

示例

st=>start: Start:>https://www.zybuluo.com
io=>inputoutput: verification
op=>operation: Your Operation
cond=>condition: Yes or No?
sub=>subroutine: Your Subroutine
e=>end

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

更多語法參考:流程圖語法參考

8. 序列圖

示例 1

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

示例 2

Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow

更多語法參考:序列圖語法參考

9. 甘特圖

甘特圖內在思想簡單。基本是一條線條圖,橫軸表示時間,縱軸表示活動(項目),線條表示在整個期間上計劃和實際的活動完成情況。它直觀地表明任務計劃在什么時候進行,及實際進展與計劃要求的對比。

    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

更多語法參考:甘特圖語法參考

10. Mermaid 流程圖

    A[Hard edge] -->|Link text| B(Round edge)
    B --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]

更多語法參考:Mermaid 流程圖語法參考

11. Mermaid 序列圖

    Alice->John: Hello John, how are you?
    loop every minute
        John-->Alice: Great!
    end

更多語法參考:Mermaid 序列圖語法參考

12. 表格支持

項目 價格 數量
計算機 $1600 5
手機 $12 12
管線 $1 234

13. 定義型列表

名詞 1
: 定義 1(左側有一個可見的冒號和四個不可見的空格)

代碼塊 2
: 這是代碼塊的定義(左側有一個可見的冒號和四個不可見的空格)

    代碼塊(左側有八個不可見的空格)

14. Html 標簽

本站支持在 Markdown 語法中嵌套 Html 標簽,譬如,你可以用 Html 寫一個縱跨兩行的表格:

<table>
    <tr>
        <th rowspan="2">值班人員</th>
        <th>星期一</th>
        <th>星期二</th>
        <th>星期三</th>
    </tr>
    <tr>
        <td>李強</td>
        <td>張明</td>
        <td>王平</td>
    </tr>
</table>

<table>
<tr>
<th rowspan="2">值班人員</th>
<th>星期一</th>
<th>星期二</th>
<th>星期三</th>
</tr>
<tr>
<td>李強</td>
<td>張明</td>
<td>王平</td>
</tr>
</table>

15. 內嵌圖標

本站的圖標系統對外開放,在文檔中輸入

<i class="icon-weibo"></i>

即顯示微博的圖標: <i class="icon-weibo icon-2x"></i>

替換 上述 i 標簽 內的 icon-weibo 以顯示不同的圖標,例如:

<i class="icon-renren"></i>

即顯示人人的圖標: <i class="icon-renren icon-2x"></i>

更多的圖標和玩法可以參看 font-awesome 官方網站。

16. 待辦事宜 Todo 列表

使用帶有 [ ] 或 [x] (未完成或已完成)項的列表語法撰寫一個待辦事宜列表,并且支持子列表嵌套以及混用Markdown語法,例如:

- [ ] **Cmd Markdown 開發**
    - [ ] 改進 Cmd 渲染算法,使用局部渲染技術提高渲染效率
    - [ ] 支持以 PDF 格式導出文稿
    - [x] 新增Todo列表功能 [語法參考](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
    - [x] 改進 LaTex 功能
        - [x] 修復 LaTex 公式渲染問題
        - [x] 新增 LaTex 公式編號功能 [語法參考](http://docs.mathjax.org/en/latest/tex.html#tex-eq-numbers)
- [ ] **七月旅行準備**
    - [ ] 準備郵輪上需要攜帶的物品
    - [ ] 瀏覽日本免稅店的物品
    - [x] 購買藍寶石公主號七月一日的船票

對應顯示如下待辦事宜 Todo 列表:

  • [ ] Cmd Markdown 開發
    • [ ] 改進 Cmd 渲染算法,使用局部渲染技術提高渲染效率
    • [ ] 支持以 PDF 格式導出文稿
    • [x] 新增Todo列表功能 語法參考
    • [x] 改進 LaTex 功能
      • [x] 修復 LaTex 公式渲染問題
      • [x] 新增 LaTex 公式編號功能 語法參考
  • [ ] 七月旅行準備
    • [ ] 準備郵輪上需要攜帶的物品
    • [ ] 瀏覽日本免稅店的物品
    • [x] 購買藍寶石公主號七月一日的船票

  1. 這是一個 注腳文本?

  2. 這是另一個 注腳文本?

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,527評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,687評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,640評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,957評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,682評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 56,011評論 1 329
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,009評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,183評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,714評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,435評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,665評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,148評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,838評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,251評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,588評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,379評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,627評論 2 380

推薦閱讀更多精彩內容