本人使用的是 MWeb Lite 工具,Mac 版 。
# Markdown 語法和 MWeb 寫作使用說明
## Markdown 的設(shè)計哲學(xué)
> Markdown 的目標(biāo)是實(shí)現(xiàn)「易讀易寫」。 > 不過最需要強(qiáng)調(diào)的便是它的可讀性。一份使用 Markdown 格式撰寫的文件應(yīng)該可以直接以純文字發(fā)佈,並且看起來不會像是由許多標(biāo)籤或是格式指令所構(gòu)成。 > Markdown 的語法有個主要的目的:用來作為一種網(wǎng)路內(nèi)容的*寫作*用語言。
<!-- more -->
## 本文約定
如果有寫 `效果如下:`, 在 MWeb 編輯狀態(tài)下只有用 `CMD + R` 預(yù)覽才可以看效果。
## 標(biāo)題
Markdown 語法:
``` # 第一級標(biāo)題 `<h1>` ## 第二級標(biāo)題 `<h2>` ###### 第六級標(biāo)題 `<h6>` ```
效果如下:
# 第一級標(biāo)題`<h1>` ## 第二級標(biāo)題`<h2>` ###### 第六級標(biāo)題 `<h6>`
## 強(qiáng)調(diào)
Markdown 語法:
``` *這些文字會生成`<em>`* _這些文字會生成`<u>`_
**這些文字會生成`<strong>`** __這些文字會生成`<strong>`__ ```
在 MWeb 中的快捷鍵為: `CMD + U`、`CMD + I`、`CMD + B` 效果如下:
*這些文字會生成`<em>`* _這些文字會生成`<u>`_
**這些文字會生成`<strong>`** __這些文字會生成`<strong>`__
## 換行
四個及以上空格加回車。 如果不想打這么多空格,只要回車就為換行,請勾選:`Preferences` - `Themes` - `Translate newlines to <br> tags`
## 列表
### 無序列表
Markdown 語法:
``` * 項(xiàng)目一 無序列表 `* + 空格鍵` * 項(xiàng)目二 * 項(xiàng)目二的子項(xiàng)目一 無序列表 `TAB + * + 空格鍵` * 項(xiàng)目二的子項(xiàng)目二 ```
在 MWeb 中的快捷鍵為: `Option + U` 效果如下:
* 項(xiàng)目一 無序列表 `* + 空格鍵` * 項(xiàng)目二 * 項(xiàng)目二的子項(xiàng)目一 無序列表 `TAB + * + 空格鍵` * 項(xiàng)目二的子項(xiàng)目二
### 有序列表
Markdown 語法:
``` 1. 項(xiàng)目一 有序列表 `數(shù)字 + . + 空格鍵` 2. 項(xiàng)目二 3. 項(xiàng)目三 1. 項(xiàng)目三的子項(xiàng)目一 有序列表 `TAB + 數(shù)字 + . + 空格鍵` 2. 項(xiàng)目三的子項(xiàng)目二 ```
效果如下:
1. 項(xiàng)目一 有序列表 `數(shù)字 + . + 空格鍵` 2. 項(xiàng)目二 3. 項(xiàng)目三 1. 項(xiàng)目三的子項(xiàng)目一 有序列表 `TAB + 數(shù)字 + . + 空格鍵` 2. 項(xiàng)目三的子項(xiàng)目二
### 任務(wù)列表(Task lists)
Markdown 語法:
``` - [ ] 任務(wù)一 未做任務(wù) `- + 空格 + [ ]` - [x] 任務(wù)二 已做任務(wù) `- + 空格 + [x]` ```
效果如下:
- [ ] 任務(wù)一 未做任務(wù) `- + 空格 + [ ]` - [x] 任務(wù)二 已做任務(wù) `- + 空格 + [x]`
## 圖片
Markdown 語法:
``` ![GitHub set up](http://zh./asset/img/set-up-git.gif) 格式: ![Alt Text](url) ```
`Control + Shift + I` 可插入Markdown語法。 如果是 MWeb 的文檔庫中的文檔,還可以用拖放圖片、`CMD + V` 粘貼、`CMD + Option + I` 導(dǎo)入這三種方式來增加圖片。 效果如下:
![GitHub set up](http://zh./asset/img/set-up-git.gif)
## 鏈接
Markdown 語法:
``` email <example@example.com> [GitHub](http://github.com) 自動生成連接 <http://www.github.com/> ```
`Control + Shift + L` 可插入Markdown語法。 如果是 MWeb 的文檔庫中的文檔,拖放或`CMD + Option + I` 導(dǎo)入非圖片時,會生成連接。 效果如下:
Email 連接: <example@example.com> [連接標(biāo)題Github網(wǎng)站](http://github.com) 自動生成連接像: <http://www.github.com/> 這樣
## 區(qū)塊引用
Markdown 語法:
``` 某某說: > 第一行引用 > 第二行費(fèi)用文字 ```
`CMD + Shift + B` 可插入Markdown語法。 效果如下:
某某說: > 第一行引用 > 第二行費(fèi)用文字
## 行內(nèi)代碼
Markdown 語法:
``` 像這樣即可:`<addr>` `code` ```
`CMD + K` 可插入Markdown語法。 效果如下:
像這樣即可:`<addr>` `code`
## 多行或者一段代碼
Markdown 語法:
```js function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }
} ```
`CMD + Shift + K` 可插入Markdown語法。 效果如下:
```js function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }
} ```
## 順序圖或流程圖
Markdown 語法:
```sequence 張三->李四: 嘿,小四兒, 寫博客了沒? Note right of 李四: 李四愣了一下,說: 李四-->張三: 忙得吐血,哪有時間寫。 ```
```flow st=>start: 開始 e=>end: 結(jié)束 op=>operation: 我的操作 cond=>condition: 確認(rèn)?
st->op->cond cond(yes)->e cond(no)->op ```
效果如下( `Preferences` - `Themes` - `Enable sequence & flow chart` 才會看到效果 ):
```sequence 張三->李四: 嘿,小四兒, 寫博客了沒? Note right of 李四: 李四愣了一下,說: 李四-->張三: 忙得吐血,哪有時間寫。 ```
```flow st=>start: 開始 e=>end: 結(jié)束 op=>operation: 我的操作 cond=>condition: 確認(rèn)?
st->op->cond cond(yes)->e cond(no)->op ```
更多請參考:<http://bramp./js-sequence-diagrams/>, <http://adrai./flowchart.js/>
## 表格
Markdown 語法:
``` 第一格表頭 | 第二格表頭 --------- | ------------- 內(nèi)容單元格 第一列第一格 | 內(nèi)容單元格第二列第一格 內(nèi)容單元格 第一列第二格 多加文字 | 內(nèi)容單元格第二列第二格 ```
效果如下:
第一格表頭 | 第二格表頭 --------- | ------------- 內(nèi)容單元格 第一列第一格 | 內(nèi)容單元格第二列第一格 內(nèi)容單元格 第一列第二格 多加文字 | 內(nèi)容單元格第二列第二格
## 刪除線
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} } } } \\]
行內(nèi)公式: $\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} } } } \\]
行內(nèi)公式: $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$
## 腳注(Footnote)
Markdown 語法:
``` 這是一個腳注:[^sample_footnote] ```
效果如下:
這是一個腳注:[^sample_footnote]
[^sample_footnote]: 這里是腳注信息
## 注釋和閱讀更多
<!-- comment --> <!-- more --> Actions->Insert Read More Comment *或者* `Command + .` **注** 閱讀更多的功能只用在生成網(wǎng)站或博客時。
## TOC
Markdown 語法:
``` [TOC] ```
效果如下:
[TOC]
|
|