最近對它的README.md文件頗為感興趣。便寫下這簡書获搏，希望幫助更多的還不會編寫README文件的同學(xué)們怖喻。
README文件后綴名為md。md是markdown的縮寫充蓝，markdown是一種編輯博客的語言隧枫。
Markdown 語法簡單用法
- 標題
大標題
=======
小標題
- ' #'+漢字組成各級標題，中間要空格
一級標題
二級標題
三級標題
四級標題
五級標題
六級標題
eg:
#一級標題
##二級標題
###三級標題
####四級標題
#####五級標題
######六級標題
注釋：大標題和小標題分別對應(yīng)一棺克、二級標題
3.下分割線
文字
“-------”
4 . 超鏈接
示例：
- [Markdown](http://www.reibang.com/p/9349ebcb14a6)
5 . 插入符號
一. 圓點符
- 昵稱：果凍蝦仁
- 別名：隔壁老王
- 英文名：Jelly
eg:
* 昵稱：果凍蝦仁
* 別名：隔壁老王
* 英文名：Jelly
二. 二級圓點 三級圓點前多加tab
- 昵稱：果凍蝦仁
- 別名：隔壁老王
- 英文名：Jelly
- 別名：隔壁老王
eg:
* 昵稱：果凍蝦仁
* 別名：隔壁老王
* 英文名：Jelly
6 .縮進
地球??
亞洲??
中國 ????
深圳
eg:
>地球??
>>亞洲??
>>>中國 ????
>>>>深圳
7 . 圖片+文字說明（gif和普通圖片相同）
圖片alt就是顯示在圖片下面的文字悠垛，相當于對圖片內(nèi)容的解釋。
圖片title是圖片的標題娜谊，當鼠標移到圖片上時顯示的內(nèi)容确买。title可加可不加
[圖片上傳失敗...(image-dfbb00-1564209815628)]
eg:
8 . 代碼引用
中國人
self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];
eg:
`中國人 `
`self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];`
9 . 文字引用
一盞燈， 一片昏黃纱皆； 一簡書湾趾， 一杯淡茶。 守著那一份淡定派草， 品讀屬于自己的寂寞搀缠。 保持淡定， 才能欣賞到最美麗的風(fēng)景近迁！ 保持淡定艺普， 人生從此不再寂寞。
eg:文字前加>
一盞燈鉴竭， 一片昏黃歧譬； 一簡書， 一杯淡茶搏存。 守著那一份淡定瑰步， 品讀屬于自己的寂寞。 保持淡定璧眠， 才能欣賞到最美麗的風(fēng)景缩焦！ 保持淡定读虏， 人生從此不再寂寞。
10 . 表格
| 星期 | 車次 | 時間 |
|---|---|---|
| 星期一 | G1008 | 4:30 |
| 星期二 | G1006 | 14:55 |
| 星期三 | G1007 | 18:30 |
| 星期四 | G1009 | 21:30 |
eg: “---------”左右兩邊的“：”決定文字的對齊方式
| 星期 | 車次 | 時間 |
| ------------- |:-------------:| -----:|
| 星期一 |G1008 | 4:30 |
| 星期二 | G1006 | 14:55 |
| 星期三 | G1007 | 18:30 |
Markdown 語法和 MWeb 寫作使用說明
效果如下：
[TOC]
Markdown 的設(shè)計哲學(xué)
Markdown 的目標是實現(xiàn)「易讀易寫」袁滥。
不過最需要強調(diào)的便是它的可讀性盖桥。一份使用 Markdown 格式撰寫的文件應(yīng)該可以直接以純文字發(fā)佈，並且看起來不會像是由許多標籤或是格式指令所構(gòu)成题翻。
Markdown 的語法有個主要的目的：用來作為一種網(wǎng)路內(nèi)容的寫作用語言葱轩。
本文約定
如果有寫 效果如下：， 在 MWeb 編輯狀態(tài)下只有用 CMD + 4 或 CMD + R 預(yù)覽才可以看效果藐握。
標題
Markdown 語法：
# 第一級標題 `<h1>`
## 第二級標題 `<h2>`
###### 第六級標題 `<h6>`
效果如下：
第一級標題 <h1>
第二級標題 <h2>
第六級標題 <h6>
強調(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 語法：
* 項目一 無序列表 `* + 空格鍵`
* 項目二
* 項目二的子項目一 無序列表 `TAB + * + 空格鍵`
* 項目二的子項目二
在 MWeb 中的快捷鍵為： Option + U
效果如下：
- 項目一 無序列表
* + 空格鍵 - 項目二
- 項目二的子項目一 無序列表
TAB + * + 空格鍵 - 項目二的子項目二
有序列表
Markdown 語法：
1. 項目一 有序列表 `數(shù)字 + . + 空格鍵`
2. 項目二
3. 項目三
1. 項目三的子項目一 有序列表 `TAB + 數(shù)字 + . + 空格鍵`
2. 項目三的子項目二
效果如下：
- 項目一 有序列表
數(shù)字 + . + 空格鍵 - 項目二
- 項目三
- 項目三的子項目一 有序列表
TAB + 數(shù)字 + . + 空格鍵 - 項目三的子項目二
任務(wù)列表（Task lists）
Markdown 語法：
- [ ] 任務(wù)一 未做任務(wù) `- + 空格 + [ ]`
- [x] 任務(wù)二 已做任務(wù) `- + 空格 + [x]`
效果如下：
- [ ] 任務(wù)一 未做任務(wù)
- + 空格 + [ ] - [x] 任務(wù)二 已做任務(wù)
- + 空格 + [x]
圖片
Markdown 語法：
格式: 
Control + Shift + I 可插入Markdown語法初家。
如果是 MWeb 的文檔庫中的文檔偎窘，還可以用拖放圖片、CMD + V 粘貼溜在、CMD + Option + I 導(dǎo)入這三種方式來增加圖片陌知。
效果如下：
[站外圖片上傳中...(image-1f771f-1550542906397)]
MWeb 引入的特別的語法來設(shè)置圖片寬度，方法是在圖片描述后加 -w + 圖片寬度 即可掖肋，比如說要設(shè)置上面的圖片的寬度為 140仆葡，語法如下：
[站外圖片上傳中...(image-c97dea-1550542906397)]
鏈接
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
連接標題Github網(wǎng)站
自動生成連接像： http://www.github.com/ 這樣
區(qū)塊引用
Markdown 語法：
某某說:
> 第一行引用
> 第二行費用文字
CMD + Shift + B 可插入Markdown語法纫溃。
效果如下：
某某說:
第一行引用
第二行費用文字
行內(nèi)代碼
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: 結(jié)束
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: 結(jié)束
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 語法：
第一格表頭 | 第二格表頭
--------- | -------------
內(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 才會看到效果）：
塊級公式：
\[ \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)公式：
腳注（Footnote）
Markdown 語法：
這是一個腳注：[^sample_footnote]
效果如下：
這是一個腳注：[1]
-
這里是腳注信息 ?
