GitHub上README寫法暨markdown語法解讀

自從開始玩GitHub以來，就 愈來愈 感受它有愛。最近對它的 README.md 文件頗爲感興趣。便寫下這貼，幫助更多的還不會編寫README文件的同窗們。

README文件後綴名爲md。md是markdown的縮寫，markdown是一種編輯博客的語言。用慣了可視化的博客編輯器（好比CSDN博客，囧），這種編程式的博客編輯方案着實讓人眼前一亮。不過貌似並不支持所有的markdown語法。本文內容大部分是我本身摸索，可能有些敘述不許確，還望你們批評指正。

————————————————————————————

我在GitHub上爲本文建的一個項目，供你們查看代碼即具體效果：https://github.com/guodongxiaren/test 

首先強烈建議一條，不要用360或搜狗瀏覽器訪問GitHub網站，你會發現此時網站上不少按鈕都不可用。。建議使用火狐或谷歌瀏覽器訪問GitHub

————————————————————————————

開始編輯README

打開你的GitHub的某個項目，咱們能夠直接在線編輯你的README文件，若是你已經有了這個文件，則在文件目錄中直接點擊它，若是你尚未這個文件那麼點擊項目名稱右邊的一個按鈕，來添加新文件：

而後你就打開了編輯頁面，編輯區的左上角有填寫文件名的區域，注意加上後綴.md

若是你原本就有這個文件要從新編輯它的話，那麼在點擊了文件目錄中的該文件後，在上方有工具欄，選擇 Edit

而後滾動屏幕到下面， 若是是新文件 會有一個 Commit new file 的按鈕，若沒有內容是不能點擊的。若是是舊文件重修編輯，那麼這個按鈕顯示的是 Commit changes

 

//順便吐槽一句若是是360或搜狗瀏覽器的話，這個按鈕是永遠都沒法點擊的，囧。。

先隨便寫的東西把這個新文件提交，而後再點擊 Edit 從新打開它。你會發現編輯區左上角有了變化。

默認選中Code，即咱們的編輯模式。若點擊 Preview（預覽）就能實時顯示當前的顯示效果了。 

好了，下面正式開始編輯這個文件

關於標題

規範的README文件開頭都寫上一個標題，這被稱爲大標題 。

大標題
====

在文本下面加上 等於號 = ，那麼上方的文本就變成了大標題。等於號的個數無限制，但必定要大於0個哦。。

比大標題低一級的是中標題，也就是顯示出來比大標題小點。

中標題-------

在文本下面加上 下劃線 - ，那麼上方的文本就變成了中標題，一樣的 下劃線個數無限制。

除此之外，關於標題還有等級表示法，分爲六個等級，顯示的文本大小依次減少。不一樣等級之間是以井號  #  的個數來標識的。一級標題有一個 #，二級標題有兩個# ，以此類推。 

#一級標題##二級標題###三級標題####四級標題#####五級標題######六級標題

注意井號#和標題名稱要並排寫做一行，顯示效果如圖：

 

實際上，前文所述的大標題和中標題是分別和一級標題和二級標題對應的。即大標題大小和一級標題相同，中標題大小和二級標題相同。 

顯示文本

普通文本 

直接輸入的文字就是普通文本。須要注意的是要換行的時候不能直接經過回車來換行，須要使用<br>。也就是html裏面的標籤 。

這是一段普通的文本，
直接回車不能換行，<br>要使用\<br>

注意第三行的<br>前加了反斜槓 \ 。目的就是像其餘語言那樣實現轉義，也就是 <  的轉義。 

效果如圖：

此外，要顯示一個 超連接 的話，就直接輸入這個連接的URL就行了。顯示出來會自動變成可連接的形式的。 

單行文本

使用兩個Tab符實現單行文本。

Hello,你們好，我是果凍蝦仁。

注意前面有兩個Tab。在GitHub上單行文本顯示效果如圖：

 

多行文本

多行文本和單行文本殊途同歸，只要在每行行首加兩個Tab

歡迎到訪
    很高興見到您
    祝您，早上好，中午好，下午好，晚安

部分文字的高亮

若是你想使一段話中部分文字高亮顯示，來起到突出強調的做用，那麼能夠把它用 `  ` 包圍起來。注意這不是單引號，而是Tab上方，數字1左邊的按鍵（注意使用英文輸入法）。

Thank `You` . Please `Call` Me `Coder`

 

文字超連接

給一段文字加入超連接的格式是這樣的 [ 要顯示的文字 ]( 連接的地址 )。好比：

[個人博客](http://blog.csdn.net/guodongxiaren)

顯示效果： 
 

你還能夠給他加上一個鼠標懸停顯示的文本。

[個人博客](http://blog.csdn.net/guodongxiaren "懸停顯示")

即在URL以後 用雙引號括起來一個字符串。一樣要注意這裏是英文雙引號。 

插入符號

圓點符

• 這是一個圓點符

• 這也是一個圓點符

上面這段的圓點是CSDN博客編輯器裏面的符號列表。寫文章在列出條目時常常用到。在GitHub的markdown語法裏也支持使用圓點符。編輯的時候使用的是星號 *

* 暱稱：果凍蝦仁
* 別名：隔壁老王
* 英文名：Jelly

要注意的是星號* 後面要有一個空格。不然顯示爲普通星號。上文的顯示效果如圖： 

 

此外還有二級圓點和三級圓點。就是多加一個Tab。

* 編程語言
    * 腳本語言
        * Python

第二行一個Tab，第三行兩個Tab。這樣用來表示層級結構就更清晰了吧，看效果：

 

若是你以爲三級的結構還不夠表達清楚的話，咱們能夠試着換一種形式，請看 字符包圍

字符包圍

我不知道稱之爲「字符包圍」是否貼切。我也是看的網上有一篇博文是這樣稱呼的，我就姑且也這樣稱呼吧。囧。。

>數據結構
>>樹
>>>二叉樹
>>>>平衡二叉樹
>>>>>滿二叉樹

顯示效果： 
 

具體這個「字符包圍」的用法可能還有其餘用法。你們本身摸索吧。 

插入圖片

來源於網絡的圖片 

網上有不少README插入圖片的教程了，經我本身屢次測試呢，發現可使用的最簡單，最基本的語法是：

![](http://www.baidu.com/img/bdlogo.gif)

即 歎號! + 方括號[ ] + 括號( ) 其中歎號裏是圖片的URL。

若是不加歎號! ,就會變成普通文本baidu了。 

在方括號裏能夠加入一些 標識性的信息，好比

![baidu](http://www.baidu.com/img/bdlogo.gif)

這個方括號裏的baidu並不會對圖像顯示形成任何改動，若是你想達到 鼠標懸停 顯示提示信息，那麼能夠仿照前面介紹的文本中的方法，就是這樣：

![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo")

在URL後面，加一個雙引號包圍的字符串，顯示效果如圖： 

GitHub倉庫裏的圖片

有時候咱們想顯示一個GitHub倉庫(或者說項目)裏的圖片而不是一張其餘來源網絡圖片，由於其餘來源的URL極可能會失效。那麼如何顯示一個GitHub項目裏的圖片呢？

其實與上面的格式基本一致的，所不一樣的就是括號裏的URL該怎麼寫。

    https://github.com / 你的用戶名 / 你的項目名 / raw / 分支名 / 存放圖片的文件夾 / 該文件夾下的圖片

這樣一目瞭然了吧。好比：

![](https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif)

我在GitHub上的用戶名guodongxiaren；有一個項目ImageCache；raw表示原數據的意思吧，不用管它；主分支master；項目裏有一個文件夾Logo；Logo文件夾下有一張圖片foryou.gif 

給圖片加上超連接

若是你想使圖片帶有超連接的功能，即點擊一個圖片進入一個指定的網頁。那麼能夠這樣寫：

[![baidu]](http://baidu.com)[baidu]:http://www.baidu.com/img/bdlogo.gif "百度Logo"

這兩句和前面的寫法差別較大，可是也極易模仿着寫出，就不過多介紹了。只需注意上下文中的 baidu 是你本身起的標識的名稱，能夠隨意，可是必定要保證上下兩行的 標識 是一致的。

這樣就能實現 點擊圖片進入網頁的功能了。 

插入代碼片斷

咱們須要在代碼的上一行和下一行用` `` 標記。``` 不是三個單引號，而是數字1左邊，Tab鍵上面的鍵。要實現語法高亮那麼只要在 ``` 以後加上你的編程語言便可（忽略大小寫）。c++語言能夠寫成c++也能夠是cpp。看代碼：

實際顯示效果

[題外話]在GitHub上用Gist寫日記吧

看了這麼多markdown的語法，你必定不知足於僅僅寫一個README文件了，開始躍躍欲試想實際用markdown語法來編寫博客或文章了吧。的確，網上也有依託或者支持markdown語法的博客。可是呢，更方便的是，你能夠藉助GitHub自己就有的一個功能——Gist。

Gist是以文件爲單位的，不是以項目爲單位的。並且與普通的GitHub上建的倉庫不一樣，Gist是private的哦。普通的項目默認都是public的，要想弄成private貌似還要交錢的樣子。既然是private那麼用來寫寫日記，是極好的。

GitHub網頁的頂部有 ：

 

點進去:

這就是你能夠編輯的私有文件，它不只支持Text文本，還支持各類編程語言呢！固然也包括markdown。輸入文件名：

最後保存，選中 Create Secret Gist 就是私有的嘍。