如何编写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 /\> * 在行首加点 行首输入*,空格后输入内容便可
相关文章
相关标签/搜索