Markdown语言简介

# Markdown语言简介

Markdown是一种可以使用普通文本编辑器编写的标记语言，信息情报共享平台的文档内容支持Markdown语言编写。

通过简单的标记语法，它可以使普通文本内容具有一定的格式。以下介绍一些基本及进阶的Markdown语法使用方法和简单示例，几个代码就可以完成文本各种格式的编辑和呈现。

## 1、标题

符号#的个数代表标题的级数，一级标题就用1个#号，二级标题就用2个#号。

示例：

```
# 一级标题(h1)
## 二级标题(h2)
### 三级标题(h3)
#### 四级标题(h4)
##### 五级标题(h5)
###### 六级标题(h6)
```

效果：

> # 一级标题(h1)
>
> ## 二级标题(h2)
>
> ### 三级标题(h3)
>
> #### 四级标题(h4)
>
> ##### 五级标题(h5)
>
> ###### 六级标题(h6)

## 2、字体格式（加粗、斜体、斜体加粗、删除线、下划线）

Markdown中的字体主要有正常、倾斜、加粗、加粗倾斜、删除线5种。
倾斜 字体需要在两边各使用一个*或者_
加粗 字体需要在两边各使用两个\*\*
倾斜加粗 字体需要在两边各使用三个\*\*\*
删除线 字体需要在两边各使用两个~~

示例：

```
**这是加粗的文字**
*这是倾斜的文字*
***这是斜体加粗的文字***
~~这是加删除线的文字~~
```

效果：

> **这是加粗的文字**
> *这是倾斜的文字*
> ***这是斜体加粗的文字***
> ~~这是加删除线的文字~~

## 3、列表（无序列表/有序列表/可选列表）

Markdown支持无序列表和有序列表。无序列表使用- + *进行列表标记，有序列表使用数字序号进行列表标记。有序列表和无序列表之间也可以相互嵌套。
注意:在数字之后加上\特殊符号，可以避免在行首出现空白。

示例：（无序列表）

```
- 列表内容
+ 列表内容
* 列表内容

注意：- + * 跟内容之间都要有一个空格=
```

效果：

> - 列表内容
> + 列表内容
> * 列表内容

示例：（有序列表）

```
1. 列表内容
2. 列表内容
3. 列表内容

注意：1. 跟内容之间都要有一个空格
```

效果：

> 1. 列表内容
> 2. 列表内容
> 3. 列表内容

示例：（可选列表）

```
- [ ]任务1
- [ ]任务2
- [x]任务3
```

效果：

> - [ ] 任务1
> - [ ] 任务2
> - [x] 任务3

## 4、引用

在Markdown语言中只需要在第一行使用>符号来表示引用，如果要结束引用，可以使用空行来结束内容的引用。也可以继续在引用的内容中引用另外的内容。

示例：

```
> 黄四娘家花满蹊，
千朵万朵压枝低。
> > 留连戏蝶时时舞，
自在娇莺恰恰啼。
> > > 江畔独步寻花·其六
作者：杜甫
```

效果：

> 黄四娘家花满蹊，
> 千朵万朵压枝低。
>
> > 留连戏蝶时时舞，
> > 自在娇莺恰恰啼。
> >
> > > 江畔独步寻花·其六
> > > 作者：杜甫

## 5、链接

```
(1)用<>将需要链接的内容包含起来
(2)[链接文字](链接地址 "链接标题")
(3)[链接文字][链接标记] 引用链接 [链接标记]:链接地址 "链接标题"
(4)[链接文字][] 引用链接 [链接文字]:链接地址
其中，链接地址和链接标题之间有一个空格，链接标题为可选项。
```

示例：

```
[链接文字](链接地址 "链接标题")

链接也可以用变量来代替，文档末尾附带变量地址：
这个链接用 1 作为网址变量 [Google][1]
这个链接用 url 作为网址变量 [Coding][url]
然后在文档的结尾为变量赋值（网址） 
[1]: http://www.google.com/ 
[rul]: https://www.cnblogs.com/
```

效果：

> [链接文字](链接地址 "链接标题")
>
> 链接也可以用变量来代替，文档末尾附带变量地址：
> 这个链接用 1 作为网址变量 [Google][1]
> 这个链接用 url 作为网址变量 [Coding][url]
> 然后在文档的结尾为变量赋值（网址） 
>
> [1]: http://www.google.com/
> [rul]: https://www.cnblogs.com/

## 6、图片

```
![图片名称](图片链接 图片描述)
```

如果要在图片下方不显示名称，则不写图片名参数即可。

官方How-to：https://support.typora.io/Images/

示例：

```
![百度图片.jpg](https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png  "百度图片")
```

效果：

> ![百度图片.jpg](https://www.baidu.com/img/PCtm_d9c8750bed0b3c7d089fa7d55720d6cf.png  "百度图片")

## 7、表格

第一行为表头，第二行为分割行（用来分开表头和表格正文行，使用:来指定列的对齐方向，默认居左显示），第三行及以后为正文行；列与列之间使用符号|隔开；第二行可以为不同的列指定对齐方向。

官方How-to：https://support.typora.io/Table-Editing/

示例：

```
| 左对齐 | 右对齐 | 居中对齐 || :-----| ----: | :----: || 单元格 | 单元格 | 单元格 || 单元格 | 单元格 | 单元格 |
```

效果：

> | 左对齐 | 右对齐 | 居中对齐 |
> | ------ | -----: | :------: |
> | 单元格 | 单元格 |  单元格  |
> | 单元格 | 单元格 |  单元格  |

## 8、分割线

示例：

```
---***___
```

效果：

---

***

___

## 9、代码（单行代码/多行代码块）

单行代码：在单行代码的两端分别使用一个 \' 符号来实现。 
代码块：在代码块的前后分别使用三个 \' 符号实现。

示例：

```
`printf()` 函数
```

效果：

> `printf()` 函数

示例：

````
```javascript$(document).ready(function () {alert('RUNOOB');});```
````

效果：

> ```
> javascript$(document).ready(function () {alert('RUNOOB');});
> ```

## 10、HTML支持

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

目前支持的 HTML 元素有：`<kbd>` `` `` `` `` `` ` `等 。

官方How-to：https://support.typora.io/HTML/

示例：

```
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑这是一段粗体文字
```

效果：

> 使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
> 粗体文字

## 11、转义

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

示例：

```
\\   反斜线
\`   反引号
\*   星号
\_   下划线
\{\}  花括号
\[\]  方括号
  小括号
\#   井字号
\+   加号
\-   减号
\.   英文句点
\!   感叹号
```

效果：

> \\   反斜线
> \`   反引号
> \*   星号
> \_   下划线
> \{\}  花括号
> \[\]  方括号
>   小括号
> \#   井字号
> \+   加号
> \-   减号
> \.   英文句点
> \!   感叹号

## 12、公式

当你需要在编辑器中插入数学公式时，可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后，问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。

官方How-to：https://support.typora.io/Math/

示例：

```
```katex
\displaystyle 
    \frac{1}{
        \Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{
        \frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {
        1+\frac{e^{-6\pi}}
        {1+\frac{e^{-8\pi}}
         {1+\cdots} }
        } 
    }
```

效果：
```katex
\displaystyle 
    \frac{1}{
        \Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{
        \frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {
        1+\frac{e^{-6\pi}}
        {1+\frac{e^{-8\pi}}
         {1+\cdots} }
        } 
    }
```

## 13、图表（流程图、时序图、甘特图、饼图、类图）

Markdown使用mermaid、flow、sequence工具还可以制作流程图、竖向流程图、标准流程图、标准横向流程图、UML时序图、UML复杂时序图、UML标准时序图、甘特图等等。

官方How-to：https://support.typora.io/Draw-Diagrams-With-Markdown/

示例：（竖向流程图）

````
```mermaidgraph TDA[方形] --> B(圆角)    B --> C{条件a}    C --> |a=1| D[结果1]    C --> |a=2| E[结果2]    F[竖向流程图]```
````

效果：

```mermaid
graph TD
A[方形] --> B(圆角)
    B --> C{条件a}
    C --> |a=1| D[结果1]
    C --> |a=2| E[结果2]
    F[竖向流程图]
```

示例：（标准流程图）

````
```flowst=>start: 开始框op=>operation: 处理框cond=>condition: 判断框(是或否?)sub1=>subroutine: 子流程io=>inputoutput: 输入输出框e=>end: 结束框st->op->condcond(yes)->io->econd(no)->sub1(right)->op```
````

效果：

```flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
```

示例：（横向标准流程图）

````
```flowst=>start: 开始框op=>operation: 处理框cond=>condition: 判断框(是或否?)sub1=>subroutine: 子流程io=>inputoutput: 输入输出框e=>end: 结束框st(right)->op(right)->condcond(yes)->io(bottom)->econd(no)->sub1(right)->op```
````

效果：

```flow
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
```

示例：（时序图）

````
```sequence对象A->对象B: 对象B你好吗?（请求）Note right of 对象B: 对象B的描述Note left of 对象A: 对象A的描述(提示)对象B-->对象A: 我很好(响应)对象A->对象B: 你真的好吗？```
````

效果：

```sequence
对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗？
```

示例：（复杂时序图）

````
```sequenceTitle: 标题：复杂使用对象A->对象B: 对象B你好吗?（请求）Note right of 对象B: 对象B的描述Note left of 对象A: 对象A的描述(提示)对象B-->对象A: 我很好(响应)对象B->小三: 你好吗小三-->>对象A: 对象B找我了对象A->对象B: 你真的好吗？Note over 小三,对象B: 我们是朋友participant CNote right of C: 没人陪我玩```
````

效果：

```sequence
Title: 标题：复杂使用
对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象B->小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->对象B: 你真的好吗？
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
```