Github上README.md编辑格式使用

原文章:http://guoyunsky.iteye.com/blog/1781885

用github也1.年半了,虽然在上面也陆陆续续的建了些工程。但要么就是fork别人的,要么就是自己练习用的。今天终于开了下荤,建了个开源的小项目。但发现写README.md还是需要些技巧。这里记录下来.

针对中文,演示Markdown的各种语法


大标题

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

大标题一般显示工程名,类似html的\

你只要在标题下面跟上=====即可

中标题

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

中标题一般显示重点项,类似html的\

你只要在标题下面输入------即可

### 小标题

小标题类似html的\

小标题的格式如下 ### 小标题

注意#和标题字符中间要有空格

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

### 单行文本框

这是一个单行的文本框,只要两个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)

2.[点击这里我你可以链接到我的博客](http://guoyunsky.iteye.com)

###只是显示图片

![github](http://github.com/unicorn.png"github")

###想点击某个图片进入一个网页,比如我想点击github的icorn然后再进入www.github.com

[![image]](http://www.github.com/)

[image]: http://github.com/github.png"github"

### 文字被些字符包围

> 文字被些字符包围

>

> 只要再文字前面加上>空格即可

>

> 如果你要换行的话,新起一行,输入>空格即可,后面不接文字

> 但> 只能放在行首才有效

### 文字被些字符包围,多重包围

> 文字被些字符包围开始

>

> > 只要再文字前面加上>空格即可

>

>  > > 如果你要换行的话,新起一行,输入>空格即可,后面不接文字

>

> > > > 但> 只能放在行首才有效

### 特殊字符处理

有一些特殊字符如<,#等,只要在特殊字符前面加上转义字符\即可

你想换行的话其实可以直接用html标签\


具体代码我放到github上,有兴趣的同学去clone以及补充修正,地址:

https://github.com/guoyunsky/Markdown-Chinese-Demo.git

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,898评论 25 709
  • 半生緣里,茫茫人海中的相遇,曼楨也只是和深愛的世鈞淡如水的說了句,你好。 恍若隔世,十八年後的相遇,什麼也輓回不了...
    遛毛驴的蚊子阅读 188评论 0 1
  • 2017年7月21日。在通辽内蒙古民族大学。我们迎来了毕业20周年同学会。十八位同学从四面八方赶来齐聚母校共叙同学...
    Madhurii阅读 1,262评论 0 0
  • 广州至佛山,小时候听大人讲,从珠江桥算起25公里,再往石湾30公里。记得要去佛山石湾买公仔沙煲之类,妈从不会异议,...
    德德猪阅读 408评论 0 0
  • 一个人的成功,更多的是仰赖别人,而非自己。也就是说要获得真正成成功的人生,关键在于相信他人,人生依靠自我努力成功的...
    子阳静娟阅读 388评论 0 3