GitHub的ReadMe.md文档编辑语法

0.362字数 317阅读 4364

README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Markdown,简称GFM。

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

无序列表

  • 文本1
  • 文本2
  - 文本1
  - 文本2

有序列表

1.文本1
2.文本2

  1.文本1
  2.文本2

插入网络链接

简书

[简书](http://www.baidu.com "悬停显示文字")

插入网络图片一

![](http://upload-images.jianshu.io/upload_images/1874524-b9be15e31c25eba2.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

插入网络图片二

![图片名][1]
[1]:http://latex.codecogs.com/gif.latex?\prod%20\(n_{i}\)+1

插入本地图片

图片名

给图片添加链接(不起作用)

插入单行引用

一盏灯, 一片昏黄; 一简书, 一杯淡茶。 守着那一份淡定, 品读属于自己的寂寞。 保持淡定, 才能欣赏到最美丽的风景! 保持淡定, 人生从此不再寂寞。

>一盏灯, 一片昏黄; 一简书, 一杯淡茶。 守着那一份淡定, 品读属于自己的寂寞。 保持淡定, 才能欣赏到最美丽的风景! 保持淡定, 人生从此不再寂寞。

插入多行引用

朝辞白帝彩云间
千里江陵一日还
两岸猿声啼不住
轻舟已过万重山

单行代码引用

hellow world

`hellow world`

多行代码引用

       let pauseBtn = UIButton(frame: CGRect(x: 50, y: HEIGHT-100, width: 100, height: 50))
        pauseBtn.addTarget(self, action: #selector(btnClick(_:)), for: .touchUpInside)
        pauseBtn.setTitle("暂停", for: .normal)
        pauseBtn.tag = 11
        pauseBtn.setTitleColor(UIColor.black, for: .normal)
  在代码前后加上```,格式:‘ ```代码``` ’

网络链接

http://www.baidu.com

粗体和斜体

斜体字
粗体字
加粗斜体字

*斜体字* 
**粗体字** 
***加粗斜体字***

表格格式一

表格 第一列 第二列
第一行 第一列 第二列
| 表格      | 第一列     | 第二列     |
| ---------- | :-----------:  | :-----------: |
| 第一行     | 第一列     | 第二列     |

表格格式二

表格 第一列 第二列
第一行 第一列 第二列
 表格      | 第一列     | 第二列     
 -------- | :-----------:  | :-----------: 
 第一行     | 第一列     | 第二列     

分割线




***

删除线

删除
~~删除~~

食物

水果

香蕉

推荐阅读更多精彩内容