1. 程式人生 > >github中的README.md寫法學習

github中的README.md寫法學習

EADME檔案字尾名為md。md是markdown的縮寫,markdown是一種編輯部落格的語言。
不過GitHub支援的語法在標準markdown語法的基礎上做了修改,稱為Github Flavored Markdown,簡稱GFM。

一、標題寫法

1、帶分割線標題

文字下方寫等號"=“後,就會變成大標題,等號個數不小於1個即可,顯示效果相同;
文字下方寫減號”-"後,上面的文字就會變為中標題,中標題欄位稍小一點。減號個數不小於1個即可,顯示效果相同。
如圖:

寫法舉例
效果

2、分級標題

標題有等級表示法,分為六個等級,顯示的文字大小依次減小。不同等級之間是以井號 # 的個數來標識的。一級標題有一個 #,二級標題有兩個# ,以此類推。

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

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

二、分隔線寫法

1、只顯示一條直線

如果上方有了文字,但只想顯示一條橫線,而不想把上方的文字轉義成大標題的話,那麼你就要在等於號=和文字之間補一個空行,並加上3個或以上減號(或者下劃線_,星號*)。如圖:
寫法
效果

2、顯示圓點

文字下方補空行,加一個減號或星號,可顯示一個圓點效果。

三、正文

單行文字:前面使用兩個Tab

多行文字:每行行首加兩個Tab

部分文字高亮:使用``包圍,這個符號不是單引號,而是Tab上方,數字1左邊那個按鍵的符號

文字超連結格式:要顯示的文字,在URL之後用雙引號括起來一個字串,即滑鼠懸停顯示的文字,可不寫