1. 程式人生 > >【Markdown 語法】

【Markdown 語法】

chart.js 才會 read oot 一段 哲學 分隔線 art 更多

Markdown 語法

摘抄自MWEB

Markdown 的設計哲學

Markdown 的目標是實現「易讀易寫」。
不過最需要強調的便是它的可讀性。一份使用 Markdown 格式撰寫的文件應該可以直接以純文字發佈,並且看起來不會像是由許多標籤或是格式指令所構成。
Markdown 的語法有個主要的目的:用來作為一種網路內容的寫作用語言。

本文約定

如果有寫 效果如下:, 在 MWeb 編輯狀態下只有用 CMD + 4CMD + R 預覽才可以看效果。

標題

Markdown 語法:

# 第一級標題 `<h1>` 
## 第二級標題 `<h2>` 
###### 第六級標題 `<h6>` 

效果如下:

第一級標題 <h1>

第二級標題 <h2>

第六級標題 <h6>

強調

Markdown 語法:

*這些文字會生成`<em>`*
_這些文字會生成`<u>`_

**這些文字會生成`<strong>`**
__這些文字會生成`<strong>`__

在 MWeb 中的快捷鍵為: CMD + UCMD + ICMD + B
效果如下:

這些文字會生成<em>
這些文字會生成<u>

這些文字會生成<strong>
這些文字會生成<strong>

換行

四個及以上空格加回車。
如果不想打這麽多空格,只要回車就為換行,請勾選:Preferences - Themes - Translate newlines to <br> tags

列表

無序列表

Markdown 語法:

* 項目一 無序列表 `* + 空格鍵`
* 項目二
    * 項目二的子項目一 無序列表 `TAB + * + 空格鍵`
    * 項目二的子項目二

在 MWeb 中的快捷鍵為: Option + U
效果如下:

  • 項目一 無序列表 * + 空格鍵
  • 項目二
    • 項目二的子項目一 無序列表 TAB + * + 空格鍵
    • 項目二的子項目二

有序列表

Markdown 語法:

1. 項目一 有序列表 `數字 + . + 空格鍵`
2. 項目二 
3. 項目三
    1. 項目三的子項目一 有序列表 `TAB + 數字 + . + 空格鍵`
    2. 項目三的子項目二

效果如下:

  1. 項目一 有序列表 數字 + . + 空格鍵
  2. 項目二
  3. 項目三
    1. 項目三的子項目一 有序列表 TAB + 數字 + . + 空格鍵
    2. 項目三的子項目二

任務列表(Task lists)

Markdown 語法:

- [ ] 任務一 未做任務 `- + 空格 + [ ]`
- [x] 任務二 已做任務 `- + 空格 + [x]`

效果如下:

  • [ ] 任務一 未做任務 - + 空格 + [ ]
  • [x] 任務二 已做任務 - + 空格 + [x]

圖片

Markdown 語法:

![GitHub set up](http://zh.mweb.im/asset/img/set-up-git.gif)
格式: ![Alt Text](url)

Control + Shift + I 可插入Markdown語法。
如果是 MWeb 的文檔庫中的文檔,還可以用拖放圖片、CMD + V 粘貼、CMD + Option + I 導入這三種方式來增加圖片。
效果如下:

技術分享圖片

MWeb 引入的特別的語法來設置圖片寬度,方法是在圖片描述後加 -w + 圖片寬度 即可,比如說要設置上面的圖片的寬度為 140,語法如下:

技術分享圖片

鏈接

Markdown 語法:

email <[email protected]>
[GitHub](http://github.com)
自動生成連接  <http://www.github.com/>

Control + Shift + L 可插入Markdown語法。
如果是 MWeb 的文檔庫中的文檔,拖放或CMD + Option + I 導入非圖片時,會生成連接。
效果如下:

Email 連接: [email protected]
連接標題Github網站
自動生成連接像: http://www.github.com/ 這樣

區塊引用

Markdown 語法:

某某說:
> 第一行引用
> 第二行費用文字

CMD + Shift + B 可插入Markdown語法。
效果如下:

某某說:

第一行引用
第二行費用文字

行內代碼

Markdown 語法:

像這樣即可:`<addr>` `code`

CMD + K 可插入Markdown語法。
效果如下:

像這樣即可:<addr> code

多行或者一段代碼

Markdown 語法:

```js
function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }

}
```

CMD + Shift + K 可插入Markdown語法。
效果如下:

function fancyAlert(arg) {
    if(arg) {
        $.facebox({div:'#foo'})
    }

}

順序圖或流程圖

Markdown 語法:

```sequence
張三->李四: 嘿,小四兒, 寫博客了沒?
Note right of 李四: 李四楞了一下,說:
李四-->張三: 忙得吐血,哪有時間寫。
```

```flow
st=>start: 開始
e=>end: 結束
op=>operation: 我的操作
cond=>condition: 確認?

st->op->cond
cond(yes)->e
cond(no)->op
```

效果如下( Preferences - Themes - Enable sequence & flow chart 才會看到效果 ):

張三->李四: 嘿,小四兒, 寫博客了沒?
Note right of 李四: 李四楞了一下,說:
李四-->張三: 忙得吐血,哪有時間寫。
st=>start: 開始
e=>end: 結束
op=>operation: 我的操作
cond=>condition: 確認?

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

更多請參考:http://bramp.github.io/js-sequence-diagrams/, http://adrai.github.io/flowchart.js/

表格

Markdown 語法:

第一格表頭 | 第二格表頭
--------- | -------------
內容單元格 第一列第一格 | 內容單元格第二列第一格
內容單元格 第一列第二格 多加文字 | 內容單元格第二列第二格

效果如下:

第一格表頭 第二格表頭
內容單元格 第一列第一格 內容單元格第二列第一格
內容單元格 第一列第二格 多加文字 內容單元格第二列第二格

刪除線

Markdown 語法:

加刪除線像這樣用: ~~刪除這些~~

效果如下:

加刪除線像這樣用: 刪除這些

分隔線

以下三種方式都可以生成分隔線:

***

*****

- - -

效果如下:




MathJax

Markdown 語法:

塊級公式:
$$  x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

\\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } } \\]

行內公式: $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

效果如下(Preferences - Themes - Enable MathJax 才會看到效果):

塊級公式:
$$ x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a} $$

\[ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} =
1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}}
{1+\frac{e^{-8\pi}} {1+\ldots} } } } \]

行內公式: $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$

腳註(Footnote)

Markdown 語法:

這是一個腳註:[^sample_footnote]

效果如下:

這是一個腳註:1

註釋和閱讀更多

Actions->Insert Read More Comment 或者 Command + .
閱讀更多的功能只用在生成網站或博客時,插入時註意要後空一行。

TOC

Markdown 語法:

[TOC]

效果如下:

[TOC]


  1. 這裏是腳註信息?

【Markdown 語法】