README使用的是GitHub Flavored Markdown，是markdowm语法的扩展。简称GFM。

GitHub Guides

Markdown中文文档

Markdown英文文档

• Mou-Markdown editor for developers

• Sublime+MarkdownEditing

• 有道云笔记-简单好用

以下介绍了GFM常用语法写法以及效果展示。

• 横线
• 标题
• 文本
• 图片
• 链接
• 列表
• 表格
• 块引用
• 代码高亮

效果依次为(没多大区别)

效果如下

效果如下

• 普通文本

hello world

• 单行文本

  hello world

• 文本块1

  hello ! welcome to beijing.

• 文本块2

hello !
welcome to beijing.

• 文字高亮

3333 hello 你好

• 换行

hello
world

效果

- 小明
- 小红
- 小刚

• 小明
• 小红
• 小刚

- 第一章
  - 第一节
    - 第一小节
  - 第二节
- 第二章

• 第一章
  • 第一节
    • 第一小节
  • 第二节
• 第二章

1. 第一步
1. 第二步
1. 第三步

或

1. 第一步
2. 第二步
2. 第三步

1. 第一步
2. 第二步
3. 第三步

1. 第一步
   1. 第一小步
        1. 第一小小步
        2. 第二小小步
   2. 第二小步
1. 第二步

1. 第一步
   1. 第一小步
      1. 第一小小步
      2. 第二小小步
   2. 第二小步
2. 第二步

- [x] 任务一
- [x] 任务二
- [x] 任务三
- [ ] 任务四
- [ ] 任务五
- [ ] 任务六

• 任务一
• 任务二
• 任务三
• 任务四
• 任务五
• 任务六

| 标题一  | 标题2 | 标题三 |  
| :--- | :---: | ---: |
| 左对齐  | 居中  | 右对齐 |

> 文本

I have a dream that my four little children will one day live in a nation where they will not be judged by the color of their skin but by the content of their character.
I have a dream today!
--马丁·路德·金

json

```json
{
"_id":"1",
"name":"小明"
}
```  

swift

```Swift
var name:String = "小明"
```

    {
    "_id":"1",
    "name":"小明"
}

    var name:String = "小明"