原文章:http://guoyunsky.iteye.com/blog/1781885
用github也1.年半了,雖然在上面也陸陸續(xù)續(xù)的建了些工程失都。但要么就是fork別人的匿级，要么就是自己練習(xí)用的。今天終于開了下葷,建了個開源的小項目媳板。但發(fā)現(xiàn)寫README.md還是需要些技巧桑腮。這里記錄下來.
針對中文,演示Markdown的各種語法
大標(biāo)題
===================================
大標(biāo)題一般顯示工程名,類似html的\
你只要在標(biāo)題下面跟上=====即可
中標(biāo)題
-----------------------------------
中標(biāo)題一般顯示重點(diǎn)項,類似html的\
你只要在標(biāo)題下面輸入------即可
###?小標(biāo)題
小標(biāo)題類似html的\
小標(biāo)題的格式如下?###?小標(biāo)題
注意#和標(biāo)題字符中間要有空格
###?注意!!!下面所有語法的提示我都先用小標(biāo)題提醒了!!!
###?單行文本框
這是一個單行的文本框,只要兩個Tab再輸入文字即可
###?多行文本框
這是一個有多行的文本框
你可以寫入代碼等,每行文字只要輸入兩個Tab再輸入文字即可
這里你可以輸入一段代碼
###?比如我們可以在多行文本框里輸入一段代碼,來一個Java版本的HelloWorld吧
public?class?HelloWorld?{
/**
*?@param?args
*/
public?static?void?main(String[]?args)?{
System.out.println("HelloWorld!");
}
}
###?鏈接
1.[點(diǎn)擊這里你可以鏈接到www.google.com](http://www.google.com)
2.[點(diǎn)擊這里我你可以鏈接到我的博客](http://guoyunsky.iteye.com)
###只是顯示圖片
![github](http://github.com/unicorn.png"github")
###想點(diǎn)擊某個圖片進(jìn)入一個網(wǎng)頁,比如我想點(diǎn)擊github的icorn然后再進(jìn)入www.github.com
[![image]](http://www.github.com/)
[image]:?http://github.com/github.png"github"
###?文字被些字符包圍
>?文字被些字符包圍
>
>?只要再文字前面加上>空格即可
>
>?如果你要換行的話,新起一行,輸入>空格即可,后面不接文字
>?但>?只能放在行首才有效
###?文字被些字符包圍,多重包圍
>?文字被些字符包圍開始
>
>?>?只要再文字前面加上>空格即可
>
>??>?>?如果你要換行的話,新起一行,輸入>空格即可,后面不接文字
>
>?>?>?>?但>?只能放在行首才有效
###?特殊字符處理
有一些特殊字符如<,#等,只要在特殊字符前面加上轉(zhuǎn)義字符\即可
你想換行的話其實可以直接用html標(biāo)簽\
具體代碼我放到github上,有興趣的同學(xué)去clone以及補(bǔ)充修正,地址:
