本文最后更新于：2014-08-01 12:44:50
原文：http://www.yaosansi.com/post/markdown-on-github/

目录

  1. 基本写作
    1.1 段落
    1.2 标题
    1.3 引用
    1.4 粗体和斜体
    1.5 删除线
  2. 列表
    2.1 无序列表
    2.1 有序列表
    2.3 嵌套列表
  3. 代码格式化
    3.1 单行格式化
    3.2 多行格式化
  4. 链接和图片
    4.1 链接
    4.2 图片
  5. GitHub扩展语法
    5.1 语法高亮
    5.2 任务列表
    5.3 表格
  6. 其它
    6.1 转义字符

[TOC]

Markdown基础

1. 基本写作

1.1 段落

段落在Markdown中由一行或多行的空白行组成.

1
2
3
这是段落一. 这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.

这是段落二.这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二.

这是段落一. 这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.这是段落一.

这是段落二.这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二. 这是段落二.

1.2 标题

在标题文字前面加一个或多个#符号,此行文字即为一行标题.#符号的数量决定标题的大小.

1
2
3
4
# 这是标题一 (<h1>)
## 这是标题二 (<h2>)
...
###### 这是标题六(<h6>)

这是标题一

这是标题二

…

这是标题六

1.3 引用

引用以>符号开始

1
2
下面就是引用
> 这里是引用

下面就是引用

这里是引用

1.4 粗体和斜体

1
2
*这是斜体*
**这是粗体**

这是斜体
这是粗体

也可使用下划线(_)代替(*)号

1.5 删除线

1
~~这是删除线~~

这是删除线

2. 列表

2.1 无序列表

可以在每个列表项前加星号(*)或横线(-)

1
2
3
4
5
6
7
* 项目一
* 项目二
* 项目三

- 项目一
- 项目二
- 项目三
  • 项目一
  • 项目二
  • 项目三
  • 项目一
  • 项目二
  • 项目三

2.2 有序列表

在每个项目前增加数字和句点(英文)即可.

1
2
3
1. 项目一
2. 项目二
3. 项目三

  1. 项目一
  2. 项目二
  3. 项目三

2.3 嵌套列表

在每个项目前增加两个空格缩进

1
2
3
4
5
6
7
8
9
10
11
12
13
1. 项目一
  1. 嵌套有序列表项目一
  2. 嵌套有序列表项目二
    - 嵌套无序列表项目一
    - 嵌套无序列表项目二
    - 嵌套无序列表项目三
      1. 多级嵌套有序列表项目一
      2. 多级嵌套有序列表项目二
        - 嵌套无序列表项目一
        - 嵌套无序列表项目二
        - 嵌套无序列表项目三
2. 项目二
3. 项目三

  1. 项目一
    1. 嵌套有序列表项目一
    2. 嵌套有序列表项目二
      • 嵌套无序列表项目一
      • 嵌套无序列表项目二
      • 嵌套无序列表项目三
      1. 多级嵌套有序列表项目一
      2. 多级嵌套有序列表项目二
        • 嵌套无序列表项目一
        • 嵌套无序列表项目二
        • 嵌套无序列表项目三
  2. 项目二
  3. 项目三

3. 代码格式化

3.1 单行格式化

使用反引号（```）作为单行代码的引用

1
Here's an idea: why don't we take `SuperiorProject` and turn it into `**Reasonable**Project`.

Here’s an idea: why don’t we take SuperiorProject and turn it into **Reasonable**Project.

3.2 多行格式化

使用三个反引号（```）作为多行代码的引用

1
2
3
4
5
6
Check out this neat program I wrote:
` ` `
x = 0
x = 2 + 2
what is x
` ` `

Check out this neat program I wrote:

1
2
3
x = 0
x = 2 + 2
what is x

4. 链接和图片

###　4.1　链接
链接的格式如下：

1
2
3
4
5
6
7
1 http://www.yaosansi.com/   (自动生成链接)
2 [这是链接内容](http://www.yaosansi.com/这是链接地址)
3 [这是链接内容](http://www.yaosansi.com/这是链接地址 "这里是链接说明")
4 [这是链接内容][1]

文档任意位置(通常是尾部)
[1]:http://www.yaosansi.com/这是链接地址 "这里是链接说明"

1 http://www.yaosansi.com/ (自动生成链接)
2 这是链接内容
3 这是链接内容
4 这是链接内容

4.2 图片

图片格式如下:

1
![提示文字](图片地址)

提示文字
提示文字

5. GitHub扩展语法

5.1 语法高亮

1
2
3
4
5
6
7
` ` `javascript
function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}
` ` `

5.2 任务列表

1
2
3
4
5
- [x] 已完成任务一
- [x] 已完成任务二
- [x] 已完成任务三
- [ ] 未完成任务四
- [ ] 未完成任务五
  • 已完成任务一
  • 已完成任务二
  • 已完成任务三
  • 未完成任务四
  • 未完成任务五

5.3 表格

1
2
3
4
第一表头 | 第二表头
------------ | -------------
第一单元格内容 | 第二单元格内容
第一列内容 | 第二列内容
第一表头 第二表头
第一单元格内容 第二单元格内容
第一列内容 第二列内容

5.4 Emoji表情

GitHub支持Emoji : smile: : running:
更多表情参考:http://www.emoji-cheat-sheet.com/

6. 其它

6.1 转义字符

可以用反斜杠来插入一些在语法中有其它意义的符号，如：可以在星号的前面加上反斜杠

1
\*literal asterisks\*

*literal asterisks*

反斜杠支持下面的字符

1
2
3
4
5
6
7
8
9
10
11
12
\   反斜杠
`   反引号
*   星号
_   底线
{}  大括号
[]  方括号
()  括号
#   井字号
+    加号
-    减号
.   英文句点
!   惊叹号

参考