1. 程式人生 > >Markdown模板(文首附markdown原始碼,即.md檔案)

Markdown模板(文首附markdown原始碼,即.md檔案)

有道雲筆記 - Markdown模板

image

什麼是Markdown?Markdown是一種輕量級的「標記語言」,通常為程式設計師群體所用,目前它已是全球最大的技術分享網站 GitHub 和技術問答網站 StackOverFlow 的御用書寫格式。

有道雲筆記內建Markdown編輯器和使用指南,非技術類筆記使用者,千萬不要被「標記」、「語言」嚇到,Markdown的語法十分簡單,常用的標記符號不超過十個,用於日常寫作記錄綽綽有餘,不到半小時就能完全掌握。

就是這十個不到的標記符號,卻能讓人優雅地沉浸式記錄,專注內容而不是糾結排版,達到「心中無塵,碼字入神」的境界。

一、利用Markdown可以做什麼?

  1. 程式碼高亮

image

程式碼高亮

code:


@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'''


2. 製作待辦事項To-do List

image

To-do List

code:

- [x] 已完成專案1

- [x] 已完成事項1

- [x] 已完成事項2

- [ ] 待辦事項1

- [ ] 待辦事項2


3. 高效繪製 流程圖、序列圖、甘特圖、表格

流程圖:

image

code:

graph TD

A[christmas] -->B(Go shopping)

B --> C{LEt me think}

C -->|One| D[Laptop]

C -->|Two| E[iPhone]

C -->|Three|F[Car]

序列圖:

image

code:

sequenceDiagram

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

甘特圖:

image

code:

gantt

dateFormat YYYY-MM-DD

title 產品計劃表

section 初期階段

明確需求: 2016-03-01, 10d

section 中期階段

跟進開發: 2016-03-11, 15d

section 後期階段

走查測試: 2016-03-20, 9d

==tips==: 以上流程圖均為半形標點

表格:

image

表格

code:

|Item | Value | Qty |

|:------    |---------:    |:--:  |

|Computer  |  1600 USD    |  5  |

|Phone      |  12 USD      |  12  |

|Pipe      |  12 USD      |  234  |


4. 書寫數學公式

Mathematical formula y=x2

Inline math: 12[1(12)n]112=sn

code:


\oint_C x^3\, dx+4y^2\,dy

2 = \left(\frac{\left(3-x\right)\times 2}{3-x}\right)

\sum_{m=1}^\infty\sum_{n=1}^\infty\frac{m^2n}{3^m\left(m3^n+n3^m\right)}

\phi_n(\kappa) = \frac{1}{4\pi^2\kappa^2}\int_0^\infty\frac{\sin(\kappa R)}{\kappa R}\frac{\partial}{\partial R}\left[R^2\frac{\partial D_n(R)}{\partial R}\right]dR

二、有道雲筆記Markdown簡明版使用指南

0. 標題

標題是每篇文章必備而且最常用的格式。

在Markdown中,如果想將一段文字定義為標題,只需要在這段文字前面加上 #,再在 # 後加一個空格即可。還可增加二、三、四、五、六級標題,總共六級,只需要增加 # ,增加一個 # ,標題字號相應降低一級。如圖:

image

code:

# 一級標題

## 二級標題

### 三級標題

#### 四級標題

1. 列表

列表格式也很常用,它可以讓你的文稿變得井井有條。在 Markdown 中,你只需要在文字前面加上 - 就可以了;如果你希望是有序列表,在文字前面加上 1. 2. 3. 即可

無序列表

code:

- 列表1

- 列表1.1

- 列表1.2

- 列表2

- 列表3

有序列表

code:

1. 列表1

1. 列表1.1

2. 列表1.2

2. 列表2

3. 列表3

2. 引用

如果你需要在文稿中引用一段別處的句子,那麼就要用到「引用」格式。

在引用文字前加上 > 並與文字保留一個字元的空格,即可。

image

引用

code:

> 記錄, 成為更好的自己。————有道雲筆記

3. 粗體和斜體

Markdown 的粗體和斜體也非常簡單:

用兩個 * 包含一段文字就是粗體的語法;

用一個 * 包含一段文字就是斜體的語法。

image

code:

*這是斜體*

**這是粗體**

注意: 符號與文字之間無需空格

4. 連結和圖片


連結:在 Markdown 中,插入連結只需要使用 [顯示文字](連結地址) 即可。

圖片:在 Markdown 中,插入圖片只需要使用 ![顯示文字](圖片連結地址)即可。

注:插入圖片的語法和連結的語法很像,只是前面多了一個 !

image

插入連結

code:

[有道雲筆記官網](http://note.youdao.com/)

插入圖片

code:

![有道雲筆記](http://note.youdao.com/favicon.ico)

5. 分割線

分割線的語法只需要另起一行,連續輸入三個星號 * 即可分割兩段文字內容。

如圖:

image

分割線

code:

這是第一段內容

***

這是第二段內容

6. 表格

當你需要在Markdown文稿中鍵入表格,程式碼如下:

image

示例參考:

表格

code:

|Item | Value | Qty |

|:------    |---------:    |:--:  |

|Computer  |  1600 USD    |  5  |

|Phone      |  12 USD      |  12  |

|Pipe      |  12 USD      |  234  |


如上7大格式是寫作文稿時最常使用的。

怎麼樣,看了相關Markdown語法是不是覺得挺簡單?

當然,Markdown新手在使用不熟練的情況下,可能會忘記相關語法,也沒關係,筆記的工具欄內建了Markdown語法,方便學習與熟悉。

如,「表格」語法相對複雜,你可能忘記了,這時候,你只需要點選編輯框上方工具欄,點選「表格」的圖示,左邊編輯區便會出現「表格」相應程式碼:

image

然後,你只需要將程式碼替換成相應文字即可,如圖:

熟悉語法之後,還是建議大家少使用輔助工具欄,儘量自己鍵入程式碼,感受純文字之美。

當然,有道雲筆記的Markdown還能支援製作待辦事項,書寫流程圖、序列圖、甘特圖,書寫數學公式等,是不是夠極客,夠有逼格?

看看筆記菌用Markdown甘特圖寫的專案計劃時間表:

image

Tips for 有道雲筆記中的 Markdown

① 實時同步預覽,所看即所得

我們將筆記編輯介面一分為二,左邊為編輯區,右邊為預覽區,兩區滾動條同步。在編輯區的操作能夠實時反映在預覽區,方便及時調整和檢視最終版面效果。

② 工具欄內建Markdown語法,方便新手學習

編輯頁面頂端的工具欄有對應程式碼,如果你是一個不熟悉Markdown語法的新手,可以先嚐試用工具欄輔助操作。也可以在網上搜索「Markdown語法指南」進行學習。

當然,如果你覺得工具欄太打擾,點選下方分界條即可隱藏工具欄,切換到極簡編輯環境。

③ 實時雲端儲存

Markdown模式繼承了有道雲筆記的優良傳統,你每一次擊鍵的內容都會實時儲存在雲端,無需擔心瀏覽器崩潰、裝置沒電、突然斷網等情況。對於寫作者來說,更是再也不用擔心因為各種原因痛失文稿的情況了。

④ 介面大小可點選分界條調整。

點選“1”處,工具欄收起;

點選“2”處,右側預覽區收起。

image

附 本文的markdown原始碼

### 有道雲筆記 - Markdown模板

附 本文的Markdown原始碼: 
<https://github.com/yanglr/AlgoSolutions/blob/master/Youdao_Note_Markdown_Template.md>
點選"Raw"可看到原始碼,歡迎fork或star~
<br>
[toc] 

<font size=4></font>

抽空把[【簡明版】有道雲筆記Markdown指南](http://note.youdao.com/iyoudao/?p=2411)的圖片版歡迎成了Markdown,有需要的速速拿去~


    ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/758x240-2.jpg)

什麼是Markdown?Markdown是一種輕量級的「標記語言」,通常為程式設計師群體所用,目前它已是全球最大的技術分享網站 GitHub 和技術問答網站 StackOverFlow 的御用書寫格式。

**有道雲筆記內建Markdown編輯器和使用指南,非技術類筆記使用者,千萬不要被「標記」、「語言」嚇到,Markdown的語法十分簡單,常用的標記符號不超過十個,用於日常寫作記錄綽綽有餘,不到半小時就能完全掌握。**

就是這十個不到的標記符號,卻能讓人**優雅地沉浸式記錄,專注內容而不是糾結排版**,達到「心中無塵,碼字入神」的境界。

# 一、利用Markdown可以做什麼?

1. 程式碼高亮

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/1-1%E4%BB%A3%E7%A0%81%E9%AB%98%E4%BA%AE.png)

### 程式碼高亮

```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'''



2. 製作待辦事項To-do List

    ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/1-2%E5%BE%85%E5%8A%9E%E4%BA%8B%E9%A1%B9.png)





<div class="se-preview-section-delimiter"></div>

### To-do List

- [x] 已完成專案1

- [x] 已完成事項1

- [x] 已完成事項2

- [ ] 待辦事項1

- [ ] 待辦事項2

3. 高效繪製 流程圖、序列圖、甘特圖、表格





<div class="se-preview-section-delimiter"></div>

### 流程圖:

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/%E6%B5%81%E7%A8%8B%E5%9B%BE.png)


graph TD

A[christmas] -->B(Go shopping)

B --> C{LEt me think}

C -->|One| D[Laptop]

C -->|Two| E[iPhone]

C -->|Three|F[Car]







<div class="se-preview-section-delimiter"></div>

### 序列圖:

![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/%E5%BA%8F%E5%88%97%E5%9B%BE.png)


sequenceDiagram

loop every day

Alice->>John: Hello John, how are you?

John-->> Alice: Great!

end







<div class="se-preview-section-delimiter"></div>

### 甘特圖:

    ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/%E7%94%98%E7%89%B9%E5%9B%BE.png)



gantt

dateFormat YYYY-MM-DD

title 產品計劃表

section 初期階段

明確需求: 2016-03-01, 10d

section 中期階段

跟進開發: 2016-03-11, 15d

section 後期階段

走查測試: 2016-03-20, 9d



**==tips==: 以上流程圖均為半形標點**






<div class="se-preview-section-delimiter"></div>

### 表格:

![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/1-3%E8%A1%A8%E6%A0%BC.png)





<div class="se-preview-section-delimiter"></div>

### 表格

|Item | Value | Qty |

|:------    |---------:    |:--:  |

|Computer  |  1600 USD    |  5  |

|Phone      |  12 USD      |  12  |

|Pipe      |  12 USD      |  234  |

4. 書寫數學公式

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/%E6%95%B0%E5%AD%A6%E5%85%AC%E5%BC%8F.png)






<div class="se-preview-section-delimiter"></div>

## Mathematical formula `$y = x^2$`

Inline math: `$\dfrac{\tfrac{1}{2}[1-(\tfrac{1}{2})^n]}{1 - \tfrac{1}{2}} = s_n$`

Math block:





<div class="se-preview-section-delimiter"></div>

```math

\oint_C x^3\, dx+4y^2\,dy

2 = \left(\frac{\left(3-x\right)\times 2}{3-x}\right)

\sum_{m=1}^\infty\sum_{n=1}^\infty\frac{m^2n}{3^m\left(m3^n+n3^m\right)}

\phi_n(\kappa) = \frac{1}{4\pi^2\kappa^2}\int_0^\infty\frac{\sin(\kappa R)}{\kappa R}\frac{\partial}{\partial R}\left[R^2\frac{\partial D_n(R)}{\partial R}\right]dR



# 二、有道雲筆記Markdown簡明版使用指南

**0. 標題**

標題是每篇文章必備而且最常用的格式。

在Markdown中,如果想將一段文字定義為標題,只需要在這段文字前面加上 #,再在 # 後加一個空格即可。還可增加二、三、四、五、六級標題,總共六級,只需要增加 # ,增加一個 # ,標題字號相應降低一級。如圖:

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-0-%E6%A0%87%E9%A2%98.png)

# 一級標題

## 二級標題

### 三級標題

#### 四級標題

**1. 列表**

列表格式也很常用,它可以讓你的文稿變得井井有條。在 Markdown 中,你只需要在文字前面加上 - 就可以了;如果你希望是有序列表,在文字前面加上 1. 2. 3. 即可

#### 無序列表

- 列表1

- 列表1.1

- 列表1.2

- 列表2

- 列表3

-

#### 有序列表

1. 列表1

1. 列表1.1

2. 列表1.2

2. 列表2

3. 列表3

**2. 引用**

如果你需要在文稿中引用一段別處的句子,那麼就要用到「引用」格式。

在引用文字前加上 > 並與文字保留一個字元的空格,即可。

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-2%E5%BC%95%E7%94%A8.png)

######引用

    > 記錄, 成為更好的自己。————有道雲筆記


**3. 粗體和斜體**

Markdown 的粗體和斜體也非常簡單:

用兩個 * 包含一段文字就是粗體的語法;

用一個 * 包含一段文字就是斜體的語法。

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-3-%E7%B2%97%E4%BD%93%E6%96%9C%E4%BD%93.png)

*這是斜體*

**這是粗體**

#### 注意: 符號與文字之間無需空格

**4. 連結和圖片**


連結:在 Markdown 中,插入連結只需要使用 [顯示文字](連結地址) 即可。

圖片:在 Markdown 中,插入圖片只需要使用 ![顯示文字](圖片連結地址)即可。


注:插入圖片的語法和連結的語法很像,只是前面多了一個 !

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-4%E9%93%BE%E6%8E%A5%E4%B8%8E%E5%9B%BE%E7%89%87.png)

#### 插入連結

[有道雲筆記官網](http://note.youdao.com/)

#### 插入圖片

        ![有道雲筆記](http://note.youdao.com/favicon.ico)

**5. 分割線**

分割線的語法只需要另起一行,連續輸入三個星號 *** 即可分割兩段文字內容。

如圖:

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-5-%E5%88%86%E5%89%B2%E7%BA%BF.png)

#### 分割線

這是第一段內容

    ***

這是第二段內容

**6. 表格**

當你需要在Markdown文稿中鍵入表格,程式碼如下:

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-6%E8%A1%A8%E6%A0%BC.png)

示例參考:

### 表格

|Item | Value | Qty |

|:------    |---------:    |:--:  |

|Computer  |  1600 USD    |  5  |

|Phone      |  12 USD      |  12  |

|Pipe      |  12 USD      |  234  |

**如上7大格式是寫作文稿時最常使用的。**

怎麼樣,看了相關Markdown語法是不是覺得挺簡單?

當然,Markdown新手在使用不熟練的情況下,可能會忘記相關語法,也沒關係,筆記的工具欄內建了Markdown語法,方便學習與熟悉。

如,「表格」語法相對複雜,你可能忘記了,這時候,你只需要點選編輯框上方工具欄,點選「表格」的圖示,左邊編輯區便會出現「表格」相應程式碼:

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-6%E8%A1%A8%E6%A0%BC-3.jpg)

然後,你只需要將程式碼替換成相應文字即可,如圖:

        ![](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/1-3%E8%A1%A8%E6%A0%BC1.png)

熟悉語法之後,還是建議大家少使用輔助工具欄,儘量自己鍵入程式碼,感受純文字之美。

當然,有道雲筆記的Markdown還能支援製作待辦事項,書寫流程圖、序列圖、甘特圖,書寫數學公式等,是不是夠極客,夠有逼格?

看看筆記菌用Markdown甘特圖寫的專案計劃時間表:

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/2-6-8.png)


## Tips for 有道雲筆記中的 Markdown

**① 實時同步預覽,所看即所得**

我們將筆記編輯介面一分為二,左邊為編輯區,右邊為預覽區,兩區滾動條同步。在編輯區的操作能夠實時反映在預覽區,方便及時調整和檢視最終版面效果。

**② 工具欄內建Markdown語法,方便新手學習**

編輯頁面頂端的工具欄有對應程式碼,如果你是一個不熟悉Markdown語法的新手,可以先嚐試用工具欄輔助操作。也可以在網上搜索「Markdown語法指南」進行學習。

當然,如果你覺得工具欄太打擾,點選下方分界條即可隱藏工具欄,切換到極簡編輯環境。

**③ 實時雲端儲存**

Markdown模式繼承了有道雲筆記的優良傳統,你每一次擊鍵的內容都會實時儲存在雲端,無需擔心瀏覽器崩潰、裝置沒電、突然斷網等情況。對於寫作者來說,更是再也不用擔心因為各種原因痛失文稿的情況了。

**④ 介面大小可點選分界條調整。**

點選“1”處,工具欄收起;

點選“2”處,右側預覽區收起。

        ![image](http://note.youdao.com/iyoudao/wp-content/uploads/2016/09/91.jpg)


**在有道雲筆記 - Markdown模式下的顯示效果:**

    <http://note.youdao.com/noteshare?id=6ec3c87769048bf2ba7df068f377e5a3&sub=131D97485A5E4AE5A1E2CBC0CF3E679C>