Cmd Markdown 簡明語法手冊

標(biāo)簽： Cmd-Markdown

1. 斜體和粗體

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

示例：

這是 斜體幸逆，這是 粗體磅甩。

2. 分級標(biāo)題

使用 === 表示一級標(biāo)題米间，使用 --- 表示二級標(biāo)題滩援。

示例：

這是一個(gè)一級標(biāo)題
============================

這是一個(gè)二級標(biāo)題
--------------------------------------------------

### 這是一個(gè)三級標(biāo)題

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

3. 外鏈接

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

示例：

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

4. 無序列表

使用 *，+泣棋，- 表示無序列表胶哲。

示例：

• 無序列表項(xiàng) 一
• 無序列表項(xiàng) 二
• 無序列表項(xiàng) 三

5. 有序列表

使用數(shù)字和點(diǎn)表示有序列表。

示例：

1. 有序列表項(xiàng) 一
2. 有序列表項(xiàng) 二
3. 有序列表項(xiàng) 三

6. 文字引用

使用 > 表示文字引用潭辈。

示例：

野火燒不盡鸯屿，春風(fēng)吹又生。

7. 行內(nèi)代碼塊

使用 `代碼` 表示行內(nèi)代碼塊把敢。

示例：

讓我們聊聊 html寄摆。

8. 代碼塊

使用 四個(gè)縮進(jìn)空格 表示代碼塊。

示例：

這是一個(gè)代碼塊修赞，此行左側(cè)有四個(gè)不可見的空格婶恼。

9. 插入圖像

使用  插入圖像。

示例：

我的頭像

Cmd Markdown 高階語法手冊

1. 內(nèi)容目錄

在段落中填寫 [TOC] 以顯示全文內(nèi)容的目錄結(jié)構(gòu)柏副。

[TOC]

2. 標(biāo)簽分類

在編輯區(qū)任意行的列首位置輸入以下代碼給文稿標(biāo)簽：

標(biāo)簽： 數(shù)學(xué) 英語 Markdown

或者

Tags： 數(shù)學(xué) 英語 Markdown

3. 刪除線

使用 ~~ 表示刪除線勾邦。

這是一段錯(cuò)誤的文本。

4. 注腳

使用 [^keyword] 表示注腳割择。

這是一個(gè)注腳^[1]的樣例检痰。

這是第二個(gè)注腳^[2]的樣例。

5. LaTeX 公式

$ 表示行內(nèi)公式：

質(zhì)能守恒方程可以用一個(gè)很簡潔的方程式 $E=mc^2$ 來表達(dá)锨推。

$$ 表示整行公式：

$$\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. 加強(qiáng)的代碼塊

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

非代碼示例：

$ 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. 甘特圖

甘特圖內(nèi)在思想簡單椎椰。基本是一條線條圖沾鳄，橫軸表示時(shí)間慨飘，縱軸表示活動(dòng)（項(xiàng)目），線條表示在整個(gè)期間上計(jì)劃和實(shí)際的活動(dòng)完成情況译荞。它直觀地表明任務(wù)計(jì)劃在什么時(shí)候進(jìn)行瓤的，及實(shí)際進(jìn)展與計(jì)劃要求的對比。

    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

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

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. 表格支持

13. 定義型列表

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

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

    代碼塊（左側(cè)有八個(gè)不可見的空格）

14. Html 標(biāo)簽

本站支持在 Markdown 語法中嵌套 Html 標(biāo)簽吞歼，譬如圈膏，你可以用 Html 寫一個(gè)縱跨兩行的表格：

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

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

15. 內(nèi)嵌圖標(biāo)

本站的圖標(biāo)系統(tǒng)對外開放，在文檔中輸入

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

即顯示微博的圖標(biāo)： <i class="icon-weibo icon-2x"></i>

替換 上述 i 標(biāo)簽 內(nèi)的 icon-weibo 以顯示不同的圖標(biāo)篙骡，例如：

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

即顯示人人的圖標(biāo)： <i class="icon-renren icon-2x"></i>

更多的圖標(biāo)和玩法可以參看 font-awesome 官方網(wǎng)站稽坤。

16. 待辦事宜 Todo 列表

使用帶有 [ ] 或 [x] （未完成或已完成）項(xiàng)的列表語法撰寫一個(gè)待辦事宜列表丈甸，并且支持子列表嵌套以及混用Markdown語法，例如：

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

對應(yīng)顯示如下待辦事宜 Todo 列表：

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

Guide （redmine）

這是一篇講解如何正確使用 Redmine 的 Markdown 的排版示例，學(xué)會這個(gè)很有必要杖玲，能讓你的文章有更佳清晰的排版顿仇。

引用文本：Markdown is a text formatting syntax inspired

語法指導(dǎo)

普通內(nèi)容

這段內(nèi)容展示了在內(nèi)容里面一些小的格式，比如：

• 加粗 - **加粗**
• 傾斜 - *傾斜*
• 刪除線 - ~~刪除線~~
• Code 標(biāo)記 - Code 標(biāo)記
• 超級鏈接 - [超級鏈接](http://github.com)
• huacnlee@gmail.com - [huacnlee@gmail.com](mailto:huacnlee@gmail.com)

提及用戶

@劉文舉(wenju) @梁澤宇(zeyu) ... 輸入@ 將出現(xiàn)智能提示摆马，通過@可以在課題詳情和回復(fù)里面提及用戶夺欲，信息提交以后，被提及的用戶將會收到系統(tǒng)通知（右上角消息中心）今膊，以便讓他來關(guān)注這個(gè)帖子或回帖些阅。

表情符號 Emoji

Redmine 支持表情符號，你可以用系統(tǒng)默認(rèn)的 Emoji 符號斑唬。
也可以用圖片的表情市埋，輸入 : 將會出現(xiàn)智能提示。

一些表情例子

:smile: :laughing: :dizzy_face: :sob: :cold_sweat: :sweat_smile: :cry: :triumph: :heart_eyes: :satisfied: :relaxed: :sunglasses: :weary:

:+1: :-1: :100: :clap: :bell: :gift: :question: :bomb: :heart: :coffee: :cyclone: :bow: :kiss: :pray: :shit: :sweat_drops: :exclamation: :anger:

更多表情請?jiān)L問：http://www.emoji-cheat-sheet.com

Redmine 鏈接

在任何使用文本格式的地方恕刘，Redmine都允許在資源（問題缤谎、變更、wiki頁面...）間建立超鏈接褐着。

• #124 - #124 （鏈接至一個(gè)問題,若該問題已結(jié)束則會用刪除線來表示）
• #124-6 - #124-6 （鏈接至一個(gè)問題的回復(fù)）
• [[wiki]] - [[wiki]] （鏈接至當(dāng)前項(xiàng)目的名為wiki頁面）
• [[redmine_advice:FAQ]] - [[redmine_advice:FAQ]] （顯示redmine_advice項(xiàng)目wiki頁面的一個(gè)名為'FAQ'的鏈接）
• [[redmine_advice:]] - [[redmine_advice:]] （顯示redmine_advice項(xiàng)目wiki首頁的鏈接）
• document#17 （鏈接到id為17的文檔）
• document:Greetings （鏈接到標(biāo)題為“Greeting”的文檔）
• document:"Some document" （文檔標(biāo)題包含空格時(shí)使用雙引號來表示）
• sandbox:document:"Some document" （鏈接至sandbox項(xiàng)目中標(biāo)題為“Some document”的文檔）
• version#3 （鏈接至id為3的版本）
• version:1.0.0 （鏈接到名稱為“1.0.0”的版本）
• version:"1.0 beta 2" （版本名稱包含空格時(shí)使用雙引號來表示）

更多redmine format 請?jiān)L問 : redmine_text_formatting

大標(biāo)題 - Heading 3

你可以選擇使用 H2 至 H6坷澡，使用 ##(N) 打頭，H1 不能使用含蓉，會自動(dòng)轉(zhuǎn)換成 H2频敛。

NOTE: 別忘了 # 后面需要有空格！

Heading 4

Heading 5

Heading 6

代碼塊

普通

*emphasize*    **strong**
_emphasize_    __strong__
@a = 1

語法高亮支持

如果在 ``` 后面更隨語言名稱馅扣，可以有語法高亮的效果哦斟赚，比如:

演示 Ruby 代碼高亮

class PostController < ApplicationController
  def index
    @posts = Post.desc("id).limit(10)
  end
end

演示 Rails View 高亮

<%= @posts.each do |post| %>
<div class="post"></div>
<% end %>

演示 YAML 文件

zh-CN:
  name: 姓名
  age: 年齡

Tip: 語言名稱支持下面這些: java,ruby, python, js, html, erb, css, coffee, bash, json, yml, xml ...

有序、無序列表

無序列表

• Ruby
  • Rails
    • ActiveRecord
• Go
  • Gofmt
  • Revel
• Node.js
  • Koa
  • Express

有序列表

1. Node.js
2. Express
3. Koa
4. Sails
5. Ruby
6. Rails
7. Sinatra
8. Go

表格

如果需要展示數(shù)據(jù)什么的差油，可以選擇使用表格哦

段落

留空白的換行拗军，將會被自動(dòng)轉(zhuǎn)換成一個(gè)段落，會有一定的段落間距蓄喇，便于閱讀发侵。

請注意后面 Markdown 源代碼的換行留空情況。

1. 這是一個(gè) 注腳 的 文本妆偏。 ?

2. 這是另一個(gè) 注腳 的 文本刃鳄。 ?