1. 程式人生 > >Markdown (一種標記語言)簡明語法

Markdown (一種標記語言)簡明語法

轉載自作業部落

Markdown 簡明語法手冊

標籤: Markdown

(Markdown是是一種輕量級的「標記語言」,掌握之後便會大大提升寫作撰稿效率,作為程式設計師這麼“高大上”的東西哪能不掌握呢)

1. 斜體和粗體

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

示例:

這是 斜體,這是 粗體

2. 分級標題

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

示例:

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

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

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

3. 外連結

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

示例:

這是去往 本人部落格 的連結。

4. 無序列表

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

示例:

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

5. 有序列表

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

示例:

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

6. 文字引用

使用 > 表示文字引用。

示例:

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

7. 行內程式碼塊

使用 `程式碼` 表示行內程式碼塊。

示例:

讓我們聊聊 html

8. 程式碼塊

使用 四個縮排空格 表示程式碼塊。

示例:

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

9. 插入影象

使用 ![描述](圖片連結地址) 插入影象。

示例:

我的頭像

Cmd Markdown 高階語法手冊

1. 內容目錄

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

2. 標籤分類

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

標籤: 數學 英語 Markdown

或者

Tags: 數學 英語 Markdown

3. 刪除線

使用 ~~ 表示刪除線。

這是一段錯誤的文字。

4. 註腳

使用 [^keyword] 表示註腳。

這是一個註腳1的樣例。

這是第二個註腳2的樣例。

5. LaTeX 公式

$ 表示行內公式:

質能守恆方程可以用一個很簡潔的方程式 E=mc2 來表達。

$$ 表示整行公式:

i=1nai=0 f(x1,xx,,xn)=x21+x22++x2n k=0j1γˆkjzk

訪問 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. 流程圖

示例

Created with Raphaël 2.1.0https://www.zybuluo.comStarthttps://www.zybuluo.comverificationYour OperationYes or No?EndYour Subroutineyesno

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]

11. Mermaid 序列圖

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

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>
值班人員 星期一 星期二 星期三
李強 張明 王平

15. 內嵌圖示

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

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

即顯示微博的圖示:

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

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

即顯示人人的圖示:

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. 這是另一個 註腳文字