天天看點

如何編寫github項目的README.md檔案?

針對中文,示範markdown的各種文法

大标題 

=================================== 

  大标題一般顯示工程名,類似html的\<h1\><br /> 

  你隻要在标題下面跟上=====即可  

中标題 

----------------------------------- 

  中标題一般顯示重點項,類似html的\<h2\><br /> 

  你隻要在标題下面輸入------即可 

### 小标題 

  小标題類似html的\<h3\><br /> 

  小标題的格式如下 ### 小标題<br /> 

  注意#和标題字元中間要有空格 

### 注意!!!下面所有文法的提示我都先用小标題提醒了!!!  

### 單行文本框 

    這是一個單行的文本框,隻要兩個tab再輸入文字即可 

### 多行文本框   

    這是一個有多行的文本框 

    你可以寫入代碼等,每行文字隻要輸入兩個tab再輸入文字即可 

    這裡你可以輸入一段代碼 

### 比如我們可以在多行文本框裡輸入一段代碼,來一個java版本的helloworld吧 

    public class helloworld { 

              /** 

               */ 

               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 /\> 

* 在行首加點 

行首輸入*,空格後輸入内容即可