说明

使用Markdown格式编写，适用于文档和说明。

语法

支持标准的Markdown语法，使用 markdown-it 渲染，并进行了一些扩展。
支持部分安全的HTML标签和特定属性

标题

使用#后加一个空格 作为标题符号，例如：

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

字体

星号 * 和下划线 _ 视为强调的指标。
用一个* 或_将用一个<em>标签包裹；两个** 或__将被 <strong> 标签包裹

前后两个波浪线 ~~ 包含文字为删除线

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
~~删除线~~

效果如下：

斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
删除线

分割线

使用3个中划线---或星号*** 为分割线

---
或
***

无序列表

使用 * 或 + 或 - 加后加一个空格 作为无序列表符号，例如：

* 第一项
* 第二项
* 第三项

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


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

效果如下：

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

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

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

有序列表

1. 第一项
1. 第二项
1. 第三项

效果如下：

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

嵌套列表

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

效果如下：

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

任务列表

在列表的基础上 使用 [ ] 或 [x] 标识未选中或选中的复选框

- [ ] 第一项
- [x] 第二项
- [x] 第三项
- [ ] 第四项

效果如下：

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

脚注（Footnotes）

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

越来越多的团队使用基塔后台 [^jeata]，查看基塔后台文档[^doc]。

[^jeata]: 基塔后台:  https://jeata.com/
[^doc]: 文档: https://doc.jeata.com/

效果如下：

越来越多的团队使用基塔后台 [1]，查看基塔后台文档[2]。


1. 基塔后台:  https://jeata.com/
2. 文档: https://doc.jeata.com/

引用

使用>后作为引用符号，例如：

> 区块引用
> 基塔后台

效果如下：

区块引用
基塔后台

有颜色的引用

在结尾处加加{.info}或{.warning}或{.danger}可显示级别颜色

> info级别引用 {.info}

> warning级别引用 {.warning}

> danger级别引用 {.danger}

效果如下：

info级别引用

warning级别引用

danger级别引用

代码块

文字前后单个 ` 可以做单行的代码块

`code`

效果如： code

多行代码块前后3个连续的` 包含

高亮显示代码块，在3个连续的` 同行紧跟语言名称如 javascript、html、json 等，全部支持语言见 highlight.js

```javascript
let name = '基塔后台';
console.log(name);
```

效果如下：

let name = '基塔后台';
console.log(name);

链接

格式如下：

[链接名称](链接地址)

中括号[ ]中为链接名字，小括号( ) 中是链接地址

[基塔后台](https://www.jeata.com)

效果如下：

基塔后台

图片

以感叹号!开头，中括号[ ]中为Alt文字，小括号( ) 中是图片地址

![alt属性](图片地址)

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

![logo](https://doc.jeata.com/uploads/cloud/images/m_0b547be2cfb41fd0d35396b3e9bd5d13_r.png)

效果如下：

在结尾使用{width=宽 height=高} ，可以控制图片宽高 ，例如

![logo](https://doc.jeata.com/uploads/cloud/images/m_0b547be2cfb41fd0d35396b3e9bd5d13_r.png){width=160 height=60}

效果如下：

表格

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

语法格式如下：

|  表头   | 表头  |
|  ----  | ----  |
| 单元格  | 单元格 |
| 单元格  | 单元格 |

效果如下：

高级表格

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

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

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| A      | B     | C      |
| A      | B     | C      |

效果如下：

还可以用^^合并列单元格， 用连续的|| 合并行单元格，如:

| 表头      | 表头     | 表头       |
| -------: | -------: | --------: |
| 行合并    | B        | C         |
| ^^       | B        | C         |
| A        | 列合并    ||
| 列合并    |||

效果如下：

转义符

因为Markdown文档的一些关键字如 | < 。可以通过unicode编码来显示。
将要输入的字符进行转义，之后使用转义字符即可。

Unicode 在线转义工具： http://tool.oschina.net/encode

流程图

使用多行代码块规则使用语言mermaid

更多帮助请参考 mermaid

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

效果如下：

时序图

使用多行代码块规则使用语言mermaid

更多帮助请参考 mermaid

```mermaid
sequenceDiagram
    participant 张三
    participant 李四
    张三->王五: 王五你好吗？
    loop 健康检查
        王五->王五: 与疾病战斗
    end
    Note right of 王五: 合理 食物 <br/>看医生...
    李四-->>张三: 很好!
    王五->李四: 你怎么样?
    李四-->王五: 很好!
```

效果如下：

甘特图

使用多行代码块规则使用语言mermaid

更多帮助请参考 mermaid

```mermaid
gantt
    dateFormat  YYYY-MM-DD
    title 软件开发甘特图
    section 设计
        需求　　　　　　　:done,   des1, 2014-01-06, 2014-01-08
        原型　　　　　　　:active, des2, 2014-01-09, 3d
        美术设计　　　　　:          des3, after des2, 5d
        未来任务　　　　　:          des4, after des3, 5d
    section 开发
        学习准备理解需求　:crit, done, 2014-01-06, 24h
        设计框架　　　　　:crit, done, after des2, 2d
        开发　　　　　　　:crit, active, 3d
        未来任务　　　　　:crit, 5d
        耍　　　　　　　　:2d
    section 测试
        功能测试　　　　　:active, a1, after des3, 3d
        压力测试　　　　　:after a1, 20h
        测试报告　　　　　:48h
```

效果如下：