MarkDown语法

MarkDown

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.使用 = 和 - 标记一级和二级标题

input:

1
2
3
4
5
一级标题
=================

二级标题
-----------------

2.使用 # 号标记

input:

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

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

Markdown 段落

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

input:

1
2
paragraph  /*两个以上空格加上回车*/

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

input:

1
2
3
paragraph1 
				/*一个空行*/
paragraph2

字体

Markdown 可以使用以下几种字体：

input:

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

output:

斜体
斜体
粗体
粗体
粗斜体
粗斜体

划线

划线可以通过 ~和HTML 的 <u> 标签来实现：

input:

1
2
~~划掉~~
<u>带下划线</u>

output:

划掉

带下划线

脚注

Markdown 脚注的格式如下:

input:

1
2
3
我想要一个注脚 [^zj]。

[^zj]: 我来了！！！

output:

我想要一个注脚 ^zj。

Markdown 列表

有序列表

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

input:

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

output:

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

无序列表

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

input:

1
2
3
4
5
6
7
8
9
10
11
12
* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项


- 第一项
- 第二项
- 第三项

output:

  • 第一项
  • 第二项
  • 第三项
  • 第一项
  • 第二项
  • 第三项
  • 第一项
  • 第二项
  • 第三项

列表嵌套

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

input:

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

output:

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

Markdown 区块

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

input:

1
2
3
> 区块引用
> 我是
> 一个区块

output:

区块引用
我是
一个区块

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

input:

1
2
3
> 最外层
> > 第一层嵌套
> > > 第二层嵌套

output:

最外层

第一层嵌套

第二层嵌套

区块中使用列表

input:

1
2
3
4
5
6
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

output:

区块中使用列表

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

列表中使用区块

如果要在列表项目内放进区块，那么就需要在 > 前添加四个空格的缩进。

input:

1
2
3
4
* 第一项
    > 一
    > 二
* 第二项

output:

  • 第一项

    一
    二

  • 第二项

Markdown 代码

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

input:

1
`printf()` 函数

output:

printf() 函数

代码区块

可以用 ``` 包裹一段代码，并指定一种语言（也可以不指定）：

input:

1
2
3
4
5
6
```c
#include <stdio.h>
int main() {
	return 0;
}
```

output:

1
2
3
4
#include <stdio.h>
int main() {
	return 0;
}

Markdown 链接

链接使用方法如下：

input:

1
2
3
4
5
[链接名称](链接地址)

或者

<链接地址>

output:

链接名称

高级链接:可以通过变量来设置一个链接，变量赋值在文档末尾进行

input:

1
2
3
4
5
6
7
8
这个链接用 1 作为网址变量 [Google][1]

这个链接用 crazy 作为网址变量 [sinarcsinx][sin]

然后在文档的结尾为变量赋值（网址）

[1]: http://www.google.com/
[sin]: http://sinarcsinx.fun/

output:

这个链接用 1 作为网址变量 Google

这个链接用 crazy 作为网址变量 sinarcsinx

然后在文档的结尾为变量赋值（网址）

Markdown 图片

Markdown 图片语法格式如下：

input:

1
2
3
![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")

也可以像网址那样对图片网址使用变量:

input:

1
2
3
4
这个链接用 1 作为网址变量 [crazy][1].
然后在文档的结尾为变量赋值（网址）

[1]: 图片网址

Markdown 表格

Markdown 制作表格使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。

input:

1
2
3
4
|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

output:

表头 表头
单元格 单元格
单元格 单元格

可以设置表格的对齐方式：

  • -: 设置内容和标题栏居右对齐。
  • :- 设置内容和标题栏居左对齐。
  • :-: 设置内容和标题栏居中对齐。

input:

1
2
3
4
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

output:

左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

Markdown 高级技巧

支持的 HTML 元素

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

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

input:

1
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑

output:

使用 Ctrl+Alt+Del 重启电脑

转义

Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符：

input:

1
2
**文本加粗** 
\*\* 正常显示星号 \*\*

output:

文本加粗
** 正常显示星号 **

Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：

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