2最近对它的README.md文件颇为感兴趣。便写下这简书,希望帮助更多的还不会编写README文件的同学们。
README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。
Markdown 语法简单用法
- 标题
大标题
=======
小标题
- ' #'+汉字组成各级标题,中间要空格
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
eg:
#一级标题
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题
注释:大标题和小标题分别对应一、二级标题
3.下分割线
文字
“-------”
4 . 文字超链接 百度
文字(URL)
5 . 插入符号
一. 圆点符
- 昵称:果冻虾仁
- 别名:隔壁老王
- 英文名:Jelly
eg:
* 昵称:果冻虾仁
* 别名:隔壁老王
* 英文名:Jelly
二. 二级圆点 三级圆点前多加tab
- 昵称:果冻虾仁
- 别名:隔壁老王
- 英文名:Jelly
- 别名:隔壁老王
eg:
* 昵称:果冻虾仁
* 别名:隔壁老王
* 英文名:Jelly
6 .缩进
地球
亚洲
中国
深圳
eg:
>地球
>>亚洲
>>>中国
>>>>深圳
7 . 图片+文字说明(gif和普通图片相同)
eg:
![小黄鸡](http://upload-images.jianshu.io/upload_images/4673907-2074192aa737527d.gif?imageMogr2/auto-orient/strip)
![美景](http://img2.imgtn.bdimg.com/it/u=708621475,197951563&fm=23&gp=0.jpg)
8 . 代码引用
中国人
self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];
eg:
`中国人 `
`self.view.backgroundColor = [UIColor colorForHex:@"6FBF5E"];`
9 . 文字引用
一盏灯, 一片昏黄; 一简书, 一杯淡茶。 守着那一份淡定, 品读属于自己的寂寞。 保持淡定, 才能欣赏到最美丽的风景! 保持淡定, 人生从此不再寂寞。
eg:文字前加>
一盏灯, 一片昏黄; 一简书, 一杯淡茶。 守着那一份淡定, 品读属于自己的寂寞。 保持淡定, 才能欣赏到最美丽的风景! 保持淡定, 人生从此不再寂寞。
10 . 表格
星期 | 车次 | 时间 |
---|---|---|
星期一 | G1008 | 4:30 |
星期二 | G1006 | 14:55 |
星期三 | G1007 | 18:30 |
星期四 | G1009 | 21:30 |
eg: “---------”左右两边的“:”决定文字的对齐方式
| 星期 | 车次 | 时间 |
| ------------- |:-------------:| -----:|
| 星期一 |G1008 | 4:30 |
| 星期二 | G1006 | 14:55 |
| 星期三 | G1007 | 18:30 |