MarkDown MarkDown語法介紹
markdown 語法的一篇不錯的介紹文件,留檔備份下。。。
自從開始玩GitHub以來,就 越來越 感覺它有愛。最近對它的 README.md 檔案頗為感興趣。便寫下這貼,幫助更多的還不會編寫README檔案的同學們。
README檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。用慣了視覺化的部落格編輯器(比如CSDN部落格,囧),這種程式設計式的部落格編輯方案著實讓人眼前一亮。不過貌似並不支援全部的markdown語法。本文內容大部分是我自己摸索,可能有些敘述不準確,還望大家批評指正。
————————————————————————————
首先強烈建議一條,不要用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 就是私有的嘍。