如何編寫github項目的README.md文件?

針對中文,演示Markdown的各類語法 html

具體的項目效果能夠參考:https://github.com/guoyunsky/Markdown-Chinese-Demo   git

大標題
===================================
  大標題通常顯示工程名,相似html的\<h1\><br />
  你只要在標題下面跟上=====便可 
  
中標題
-----------------------------------
  中標題通常顯示重點項,相似html的\<h2\><br />
  你只要在標題下面輸入------便可
  
### 小標題
  小標題相似html的\<h3\><br />
  小標題的格式以下 ### 小標題<br />
  注意#和標題字符中間要有空格

### 注意!!!下面全部語法的提示我都先用小標題提醒了!!! 

### 單行文本框
    這是一個單行的文本框,只要兩個Tab再輸入文字便可
        
### 多行文本框  
    這是一個有多行的文本框
    你能夠寫入代碼等,每行文字只要輸入兩個Tab再輸入文字便可
    這裏你能夠輸入一段代碼

### 好比咱們能夠在多行文本框裏輸入一段代碼,來一個Java版本的HelloWorld吧
    public class HelloWorld {
              /**
              * @param args                */                public static void main(String[] args) {                        System.out.println("HelloWorld!");               }     } ### 連接 1.[點擊這裏你能夠連接到www.google.com](http://www.google.com)<br /> 2.[點擊這裏我你能夠連接到個人博客](http://guoyunsky.iteye.com)<br /> ###只是顯示圖片 ![github](http://github.com/unicorn.png "github") ###想點擊某個圖片進入一個網頁,好比我想點擊github的icorn而後再進入www.github.com [![image]](http://www.github.com/) [image]: http://github.com/github.png "github" ### 文字被些字符包圍 > 文字被些字符包圍 > > 只要再文字前面加上>空格便可 > > 若是你要換行的話,新起一行,輸入>空格便可,後面不接文字 > 但> 只能放在行首纔有效 ### 文字被些字符包圍,多重包圍 > 文字被些字符包圍開始 > > > 只要再文字前面加上>空格便可 > >  > > 若是你要換行的話,新起一行,輸入>空格便可,後面不接文字 > > > > > 但> 只能放在行首纔有效 ### 特殊字符處理 有一些特殊字符如<,#等,只要在特殊字符前面加上轉義字符\便可<br /> 你想換行的話其實能夠直接用html標籤\<br /\> * 在行首加點 行首輸入*,空格後輸入內容便可
相關文章
相關標籤/搜索