【分享】Github上的README.md 编写技巧
分享的原文如下：
用github也1.年半了,虽然在上面也陆陆续续的建了些工程。但要么就是fork别人的，要么就是自己练习用的。今天终于开了下荤,建了个开源的小项目。但发现写README.md还是需要些技巧。这里记录下来.
针对中文,演示Markdown的各种语法
针对中文,演示Markdown的各种语法
大标题
===================================
大标题一般显示工程名,类似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的icorn然后再进入www.github.com
[![image]](http://www.github.com/)
[image]: http://github.com/github.png "github"
### 文字被些字符包围
> 文字被些字符包围
>
> 只要再文字前面加上>空格即可
>
> 如果你要换行的话,新起一行,输入>空格即可,后面不接文字
> 但> 只能放在行首才有效
### 文字被些字符包围,多重包围
> 文字被些字符包围开始
>
> > 只要再文字前面加上>空格即可
>
> > > 如果你要换行的话,新起一行,输入>空格即可,后面不接文字
>
> > > > 但> 只能放在行首才有效
### 特殊字符处理
有一些特殊字符如<,#等,只要在特殊字符前面加上转义字符\即可<br />
你想换行的话其实可以直接用html标签\<br /\>
* 在行首加点
行首输入*，空格后输入内容即可
具体代码我放到github上,有兴趣的同学去clone以及补充修正,地址:
https://github.com/chinatjnet/Markdown-Chinese-Demo
【原文地址】
Github上README.md介绍
【参考】
TortoiseGit日常使用指南
阅读本文后，您的心情是：
恶心
愤怒
强赞
感动
路过
无聊
雷囧
关注
