最近在用gitlab,專案提交上去之後還是想著再寫個文件來描述專案的主要業務。其實，這在github上經常用README.md檔案來說明。

EADME檔案字尾名為md。md是markdown的縮寫，markdown是一種編輯部落格的語言。

不過GitHub支援的語法在標準markdown語法的基礎上做了修改，稱為Github Flavored Markdown，簡稱GFM。


寫法筆記
1、大標題的寫法
大標題
====
大標題下方寫"="後，就會變成大標題，"="個數不限，大於0即可
2、中標題的寫法
中標題
____
中標題下方寫"_"後，上面的文字就會變為中標題，中標題欄位稍小一點，下劃線個數大於0即可

除此之外，你也會發現大，中標題下面都有一條橫線，沒錯這就是 = 和 - 的顯示結果。
如果你只輸入了等於號=，但其上方無文字，那麼就只會顯示一條直線。如果上方有了文字，但你又只想顯示一條橫線，而不想把上方的文字轉義成大標題的話，那麼你就要在等於號=和文字直接補一個空行。
補空行：是很常用的用法，當你不想上下兩個不同的佈局方式交錯到一起的時候，就要在兩種佈局之間補一個空行。
如果你只輸入了短橫線（減號）-，其上方無文字，那麼要顯示直線，必須要寫三個減號以上。不過與等於號的顯示效果不同，它顯示出來時虛線而不是實線。同減號作用相同的還有星號*和下劃線_，同樣的這兩者符號也要寫三個以上才能顯示一條虛橫線。
除此以外，關於標題還有等級表示法，分為六個等級，顯示的文字大小依次減小。不同等級之間是以井號 # 的個數來標識的。一級標題有一個 #，二級標題有兩個# ，以此類推。

注意井號#和標題名稱要並排寫作一行

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

普通文字：

直接輸入的文字就是普通文字。需要注意的是要換行的時候不能直接通過回車來換行，需要使用<br>(或者<br/>)。也就是html裡面的標籤。事實上，markdown支援一些html標籤，你可以試試。當然如果你完全使用html來寫的話，就喪失意義了，畢竟markdown並非專門做前端的，然而僅實現一般效果的話，它會比html寫起來要簡潔得多得多啦。

超連結：
直接寫url，會自動轉換成超連結

文字超連結
給一段文字加入超連結的格式是這樣的 [ 要顯示的文字 ]( 連結的地址 )。比如：
我的文字(http://sxabu.iteye.com)

待續。。。