GitHub上README.md简单教程

2最近对它的README.md文件颇为感兴趣。便写下这简书,希望帮助更多的还不会编写README文件的同学们。
README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。

Markdown 语法简单用法

  1. 标题
大标题  
=======

小标题

  1. ' #'+汉字组成各级标题,中间要空格

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题
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 |

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342