GitHub上README.md教程

查看代碼即具體效果：https://github.com/guodongxiaren/test 

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

開始編輯README

打開你的GitHub的某個項(xiàng)目，我們可以直接在線編輯你的README文件，如果你已有了這個文件，則在文件目錄中直接點(diǎn)擊它，如果你還沒有這個文件那末點(diǎn)擊項(xiàng)目名稱右側(cè)的1個按鈕，來添加新文件：

然后你就打開了編輯頁面，編輯區(qū)的左上角有填寫文件名的區(qū)域，注意加上后綴.md

如果你本來就有這個文件要重新編輯它的話，那末在點(diǎn)擊了文件目錄中的該文件后，在上方有工具欄，選擇Edit

然后轉(zhuǎn)動屏幕到下面，如果是新文件會有1個Commit new file的按鈕，若沒有內(nèi)容是不能點(diǎn)擊的。如果是舊文件重修編輯，那末這個按鈕顯示的是 Commit changes

//順便吐槽1句如果是360或搜狗閱讀器的話，這個按鈕是永久都沒法點(diǎn)擊的，囧。。

先隨意寫的東西把這個新文件提交，然后再點(diǎn)擊 Edit 重新打開它。你會發(fā)現(xiàn)編輯區(qū)左上角有了變化。

默許選中Code，即我們的編輯模式。若點(diǎn)擊 Preview（預(yù)覽）就可以實(shí)時顯示當(dāng)前的顯示效果了。

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

關(guān)于標(biāo)題

規(guī)范的README文件開頭都寫上1個標(biāo)題，這被稱為大標(biāo)題。

[plain] view plaincopy

1. 大標(biāo)題  
2. ====  

比大標(biāo)題低1級的是中標(biāo)題，也就是顯示出來比大標(biāo)題小點(diǎn)。

[plain] view plaincopy

1. 中標(biāo)題  
2. -------  

在文本下面加上 下劃線 - ，那末上方的文本就變成了中標(biāo)題，一樣的 下劃線個數(shù)無窮制。

除此以外，你也會發(fā)現(xiàn)大，中標(biāo)題下面都有1條橫線，沒錯這就是 = 和 - 的顯示結(jié)果。

如果你只輸入了等于號=，但其上方無文字，那末就只會顯示1條直線。如果上方有了文字，但你又只想顯示1條橫線，而不想把上方的文字轉(zhuǎn)義成大標(biāo)題的話，那末你就要在等于號=和文字直接補(bǔ)1個空行。

補(bǔ)空行：是很經(jīng)常使用的用法，當(dāng)你不想上下兩個不同的布局方式交錯到1起的時候，就要在兩種布局之間補(bǔ)1個空行。

如果你只輸入了短橫線（減號）-，其上方無文字，那末要顯示直線，必須要寫3個減號以上。不過與等于號的顯示效果不同，它顯示出來時虛線而不是實(shí)線。同減號作用相同的還有星號*和下劃線_，一樣的這二者符號也要寫3個以上才能顯示1條虛橫線。

除此之外，關(guān)于標(biāo)題還有等級表示法，分為6個等級，顯示的文本大小順次減小。不同等級之間是以井號  #  的個數(shù)來標(biāo)識的。1級標(biāo)題有1個 #，2級標(biāo)題有兩個# ，以此類推。

[plain] view plaincopy

1. #1級標(biāo)題  
2. ##2級標(biāo)題  
3. ###3級標(biāo)題  
4. ####4級標(biāo)題  
5. #####5級標(biāo)題  
6. ######6級標(biāo)題  

實(shí)際上，前文所述的大標(biāo)題和中標(biāo)題是分別和1級標(biāo)題和2級標(biāo)題對應(yīng)的。即大標(biāo)題大小和1級標(biāo)題相同，中標(biāo)題大小和2級標(biāo)題相同。

顯示文本

普通文本

直接輸入的文字就是普通文本。需要注意的是要換行的時候不能直接通過回車來換行，需要使用
(或
)。也就是html里面的標(biāo)簽。事實(shí)上，markdown支持1些html標(biāo)簽，你可以試試。固然如果你完全使用html來寫的話，就喪失意義了，畢竟markdown并不是專門做前真?zhèn)€，但是僅實(shí)現(xiàn)1般效果的話，它會比html寫起來要簡潔很多很多啦。

[plain] view plaincopy

1. 這是1段普通的文本，  
2. 直接回車不能換行，
     
3. 要使用\
     

效果如圖：

另外，要顯示1個超鏈接的話，就直接輸入這個鏈接的URL就行了。顯示出來會自動變成可鏈接的情勢的。

顯示空格的小Tip

單行文本

使用兩個Tab符實(shí)現(xiàn)單行文本。

[plain] view plaincopy

1. Hello,大家好，我是果凍蝦仁。  

多行文本

多行文本和單行文本異曲同工，只要在每行行首加兩個Tab

[plain] view plaincopy

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

部份文字的高亮

如果你想使1段話中部份文字高亮顯示，來起到突出強(qiáng)調(diào)的作用，那末可以把它用 `  ` 包圍起來。注意這不是單引號，而是Tab上方，數(shù)字1左側(cè)的按鍵（注意使用英文輸入法）。

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

文字超鏈接

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

[plain] view plaincopy

1. [我的博客](http://blog.csdn.net/guodongxiaren)  

你還可以給他加上1個鼠標(biāo)懸停顯示的文本。

[plain] view plaincopy

1. [我的博客](http://blog.csdn.net/guodongxiaren "懸停顯示")  

插入符號

圓點(diǎn)符

• 這是1個圓點(diǎn)符
• 這也是1個圓點(diǎn)符

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

[plain] view plaincopy

1. * 昵稱：果凍蝦仁  
2. * 別名：隔壁老王  
3. * 英文名：Jelly  

另外還有2級圓點(diǎn)和3級圓點(diǎn)。就是多加1個Tab。

[plain] view plaincopy

1. * 編程語言  
2.     * 腳本語言  
3.         * Python  

如果你覺得3級的結(jié)構(gòu)還不夠表達(dá)清楚的話，我們可以試著換1種情勢，請看字符包圍

縮進(jìn)

縮進(jìn)的含義是很容易理解的。。

[plain] view plaincopy

1. >數(shù)據(jù)結(jié)構(gòu)  
2. >>樹  
3. >>>2叉樹  
4. >>>>平衡2叉樹  
5. >>>>>滿2叉樹  

固然比這個更1般的用法是這樣。常常能在書籍里面看到的效果，比如援用他人的文章。直接看效果。

具體這個“縮進(jìn)”的用法。大家自己摸索吧。

插入圖片

來源于網(wǎng)絡(luò)的圖片

網(wǎng)上有很多README插入圖片的教程了，經(jīng)我自己屢次測試呢，發(fā)現(xiàn)可使用的最簡單，最基本的語法是：

[plain] view plaincopy

生活不易，碼農(nóng)辛苦
如果您覺得本網(wǎng)站對您的學(xué)習(xí)有所幫助,可以手機(jī)掃描二維碼進(jìn)行捐贈