Github Makedown 文法入門

GitHub上建立GitHub項目，會包含了一個 README.md 檔案，此檔案編輯就會用到Markdown

本文将詳細介紹Markdown檔案（md檔案）的文法。

本文示例開源項目，請見GitHub：

https://github.com/mimvp/mimvp-markdown-syntax

1. 建立GitHub項目

文本以米撲科技的項目庫為例：mimvp

建立項目連結：https://github.com/organizations/mimvp/repositories/new

2. 檢視建立項目

mimvp-markdown-syntax

3. 下載下傳編輯 README.md

0）克隆項目到本地

https://github.com/mimvp/mimvp-markdown-syntax.git

編輯好README.md檔案後，再送出上傳到GitHub，這種方式效率低。

推薦一種更快捷的編輯README.md方式，直接在Github上編輯（推薦）

a）點選 README.md檔案

b）點選下圖紅框，直接編輯

1）Markdown 标題

markdown 支援兩種标題的文法：Setext 和 atx 形式，兩者也可以結合使用，效果更好！

a）Setext 形式

用底線的形式，利用 === （最高階标題）和 ----- （第二階标題）

Markdown 文法：

1234567891011121314151617181920

米撲科技========官網 [http://mimvp.com](http://mimvp.com) 官網 <a target="_blank" href="http://mimvp.com">http://mimvp.com</a> 米撲代理--------官網 [http://proxy.mimvp.com](http://proxy.mimvp.com) 米撲域名--------官網 <a target="_blank" href="http://domain.mimvp.com">http://domain.mimvp.com</a> 米撲财富--------官網 <a href="http://money.mimvp.com" target="_blank">http://money.mimvp.com</a>

Markdown 結果：

b）atx 形式

用#号辨別标題，最多六級标題（不支援七級、八級等标題，會直接顯示出文字）

Markdown 文法：

123456789	标題示例======== # 一級标題## 二級标題### 三級标題#### 四級标題##### 五級标題###### 六級标題

Markdown 結果：

2）Markdown 代碼塊

代碼塊，以大于号（>）開頭。若末尾不加換行符<br/>，則所有文字會連接配接在一起不會換行。

Markdown 文法：

123456	Markdown 代碼塊========> 米撲科技，小而美，簡而信，工匠藝術的網際網路服務。 <br/>> 米撲團隊，來自百度、小米、創新工場、阿裡，核心研發，實戰經驗豐富。 <br/>> 米撲産品，已上線服務包括米撲代理、米撲域名、米撲支付、米撲财富、米撲部落格等。 <br/>> 米撲科技官網： [mimvp.com](http://mimvp.com)

Markdown 結果：

3）Markdown 引用塊

引用塊，以特殊引号（`）開頭。注意：不是單引号，而是特殊引号，在鍵盤左上角的“esc”左下方的那個按鍵

Markdown 文法：

123456789	Markdown 引用塊========米撲科技簡介```米撲科技，小而美，簡而信，工匠藝術的網際網路服務。米撲團隊，來自百度、小米、創新工場、阿裡，核心研發，實戰經驗豐富。米撲産品，已上線服務包括米撲代理、米撲域名、米撲支付、米撲财富、米撲部落格等。米撲科技官網： mimvp.com```

Markdown 結果：

4）Markdown 代碼高亮

代碼高亮，以特殊引号（`）開頭，并跟上代碼語言，例如：python、java、javascript、ruby、perl、go、c、c++、bash等。

注意：不是單引号，而是特殊引号，在鍵盤左上角的“esc”左下方的那個按鍵

Markdown 文法:

1234567891011	Markdown 代碼高亮======== ```python#!/usr/bin/env python# -- coding:utf-8 -- if __name__ == "__main__": echo "hello mimvp" print("I love mimvp.com")```

Markdown 結果：

5）Markdown 字型加粗

* 或 _，表示斜體

** 或 __，表示粗體

~~ 表示删除線

Markdown 文法:

123456789	Markdown 字型加粗========我愛米撲科技 <br/>我愛米撲科技（斜體） <br/>我愛 _米撲科技_ （斜體） <br/>我愛米撲科技（粗體） <br/>我愛 __米撲科技__ （粗體） <br/>我愛 **米撲科技** （斜體 + 粗體） <br/>我愛 ~~米撲科技~~ （删除線） <br/>

Markdown 結果：

6）Markdown 無序清單

*（星号） +（加号） - （減号）表示無序清單

Markdown 文法:

12345678910111213141516171819202122232425	Markdown 無序清單======== （星号）-------- 米撲科技* 米撲代理* 米撲域名* 米撲财富 +（加号）--------+ 米撲科技+ 米撲代理+ 米撲域名+ 米撲财富 -（減号）--------- 米撲科技- 米撲代理- 米撲域名- 米撲财富

Markdown 結果：

7）Markdown 有序清單

直接用1. xxx 2. xxx 3. xxx 編輯

Markdown 文法:

1234567	Markdown 有序清單======== 1. 米撲科技2. 米撲代理3. 米撲域名4. 米撲财富

Markdown 結果：

8）Markdown 插傳入連結接

Markdown 插傳入連結接，有兩種方式：

方式1） [mimvp.com](http://mimvp.com)

方式2）<a target="_blank" href="http://mimvp.com">mimvp.com</a> （推薦）

Markdown 文法:

1234567891011121314151617181920

Markdown 結果：

9）Markdown 插入圖檔

Markdown 插入圖檔有兩種方式：

方式1） ![mimvp-logo.png](./mimvp-logo.png)

方式2） <img src="./mimvp-logo.png" title="mimvp-logo.png" />

Markdown 文法:

123456789	Markdown 插入圖檔======== ### 1. 米撲科技（預設）![mimvp-logo.png](./mimvp-logo.png) ### 2. 米撲科技（img）<img src="./mimvp-logo.png" title="mimvp-logo.png" />

Markdown 結果：

10）Markdown 表格

Makrdown 支援table表格，文法跟wiki類似。同時，也支援table标簽

方式1

Markdown 文法:

12345678	Markdown 表格========\|産品\|網址\|年份\|\|----\|-----\|-----\|\|米撲代理\|[proxy.mimvp.com](http://proxy.mimvp.com)\|2014\|\|米撲域名\|[domain.mimvp.com](http://domain.mimvp.com)\|2015\|\|米撲支付\|[pay.mimvp.com](http://pay.mimvp.com)\|2016\|\|米撲财富\|[money.mimvp.com](http://money.mimvp.com)\|2017\|

Markdown 結果：

方式2

Markdown 文法：

12345678910111213141516171819202122232425	<table><tr><td colspan="3" color="red">米撲産品</td></tr><tr><td>米撲代理</td><td>http://proxy.mimvp.com</td><td>2014</td></tr><tr><td>米撲域名</td><td>http://domain.mimvp.com</td><td>2015</td></tr><tr><td>米撲支付</td><td>http://pay.mimvp.com</td><td>2016</td></tr><tr><td>米撲财富</td><td>http://money.mimvp.com</td><td>2017</td></tr></table>

Markdown 結果：

11）Markdown 多選項

多選項，結合了多種元素，如無序清單減号（-），方括号等

Markdown 文法:

123456789	Markdown 多選項========米撲産品包含？- [x] 米撲代理- [x] 米撲域名- [x] 米撲支付- [x] 米撲财富- [ ] 米撲基金- [ ] 米撲期貨

Markdown 結果：

12）Markdown emoji表情

Markdown 文法:

1234	Markdown emoji======== @mimvp is :+1: This PR looks great - I love mimvp.com :smiley:

Markdown 結果：

13）Markdown diff 高亮對比

diff 文法是代碼高亮文法的一種，以 `+ `開頭表示新增，`- `開頭表示删除。

Markdown 文法:

123456	Markdown diff 高亮對比----------```diff+ 增加 emoji.md- 删除 emoji.txt```

Markdown 結果：

14）Markdown 其它知識

知識1： [回到頂部](#readme)

知識2：版本符号 ©

Markdown 文法:

12345	Markdown 其它知識----------\|`[回到頂部](#readme)`\|[回到頂部](#readme)\| \|`版本符号 ©`\|©\|

Markdown 結果：

15）Markdown 版權格式

一般開源項目，末尾會追加一些開原作者的資訊，例如米撲科技的作者資訊如下，供參考。

Markdown 文法:

123456	米撲科技---------- <img src="./mimvp-logo.png" title="mimvp-logo.png" /> All Right © [mimvp.com](http://mimvp.com) :blush:

Markdown 結果：

本文Markdown示例，請見米撲科技的 GitHub：

https://github.com/mimvp/mimvp-markdown-syntax