Markdown使用手册

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。

Markdown 语言在 2004 由约翰·格鲁伯（英语：John Gruber）创建。

Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。

Markdown 编写的文档后缀为 .md, .markdown。

Markdown应用

Markdown 能被使用来撰写电子书，如：Gitbook。

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。

Markdown基础

标题

使用 # 号标记

使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推。

1
2
3
4
5
6
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果如下图所示：

段落

Markdown 段落没有特殊的格式，直接编写文字就好，段落的换行是使用两个以上空格加上回车。

当然也可以在段落后面使用一个空行来表示重新开始一个段落。

字体

1
2
3
4
5
6
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

效果如下所示：

斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本

脚注

脚注是对文本的补充说明。

Markdown 脚注的格式如下:

1
2
xxx[^要注明的文本]
[^要注明的文本]:xxxxx

效果如下所示：

脚注前面要有文字^天地在兜里

列表

Markdown 支持有序列表和无序列表。

无序列表

使用星号(*)、加号(+)或是减号(-)作为列表标记，这些标记后面要添加一个空格，然后再填写内容：

1
2
3
* 第一项
+ 第一项
- 第一项

效果如下所示：

  • 第一项
  • 第一项
  • 第一项

有序列表

使用数字并加上 . 号来表示，如：

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

效果如下所示：

  1. 第一项

  2. 第二项

  3. 第三项

列表嵌套

列表嵌套只需在子列表中的选项前面添加四个空格即可：

1
2
3
4
5
6
1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

效果如下所示：

  1. 第一项：
    • 第一项嵌套的第一个元素
    • 第一项嵌套的第二个元素
  2. 第二项：
    • 第二项嵌套的第一个元素
    • 第二项嵌套的第二个元素

区块

Markdown 区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号：

区块是可以嵌套的，一个 > 符号是最外层，两个 > 符号是第一层嵌套，以此类推：

1
2
3
4
> 天地在兜里
> 我是叶一片
>> 年轻且优秀
>>> 颓废且积极

天地在兜里
我是叶一片

年轻且优秀

颓废且积极

代码

如果是段落上的一个函数或片段的代码可以用反引号把它包起来（` ），例如：

1
`这个是要包起来的` 东西

这个是要包起来的 东西

支持的 HTML 元素

不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。

目前支持的 HTML 元素有：<kbd> <b> <i> <em> <sup> <sub> <br>

等等 ，如：

1
2
3
&emsp; 空格
<font color=darkred >**带色加粗**</font>
<p align="right">居右对齐</p>

  空格
带色加粗

居右对齐