使用 Markdown

RB 使用 Markdown 富文本编辑器,支持 Markdown 的常用语法。Markdown 具有轻量化、易读易写特性,对图片、表格也提供支持,且可快速转换为其他格式如 HTML、WORD、PDF 等,被业内广泛采用。

Markdown 是一种轻量级标记语言,允许人们使用纯文本格式编写文档,然后转换成有效的 XHTML(或 HTML)文档。更多详情

基本语法

文字格式

使用特定符号包裹文字,即可实现格式化效果。

写法:

**粗体** _斜体_ ~~删除线~~ `行内代码`

效果:

粗体 斜体 删除线 行内代码

标题

使用 # 号表示标题,1 个 # 为一级标题,最多支持 6 级。# 与标题文字之间需有一个空格。

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

列表

无序列表

使用 *- 开头,加一个空格。

* 列表项 1
* 列表项 2
* 列表项 3

效果:

  • 列表项 1
  • 列表项 2
  • 列表项 3

有序列表

使用数字加 . 开头。

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

效果:

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

嵌套列表

在子项前加 2 个或以上空格即可实现嵌套。

* 一级列表项
  * 二级列表项
  * 二级列表项
* 一级列表项

效果:

  • 一级列表项
    • 二级列表项
    • 二级列表项
  • 一级列表项

图片

使用 ![]() 语法插入图片,括号内为图片地址。在编辑器中也可以通过工具栏的 [图片] 按钮直接上传图片,上传后系统会自动生成图片语法。

![](https://getrebuild.com/img/logo.png)

在系统以外(如钉钉、企业微信中)使用图片需开启 UnsafeImgAccess 参数,否则图片无法显示。详情咨询服务人员

链接

使用 []() 语法,方括号内为链接文字,圆括号内为链接地址。

[链接文字](https://getrebuild.com/)

效果:链接文字

表格

使用竖线 | 和横线 - 组合,横线行用于分隔表头和内容。表格默认左对齐,可以在横线行使用 : 控制对齐方式。

| 左对齐列 | 居中对齐列 | 右对齐列 |
| :------- | :------: | ------: |
| 内容     | 内容      |     内容 |
| 内容     | 内容      |     内容 |

效果:

左对齐列 居中对齐列 右对齐列
内容 内容 内容
内容 内容 内容

引用

使用 > 开头,常用于标注注意事项或引用文字。连续多个 > 可嵌套引用。

> 这是一段引用内容

效果:

这是一段引用内容

代码块

使用三个反引号包裹代码内容(如下方所示)。在开始的反引号后可指定语言以启用语法高亮,例如在反引号后加 javajavascript 等。

```
这是一个代码块
```

在通知内容等场景中,代码块仅作为文本展示,不会启用语法高亮

分隔线

使用三个或以上 *-_ 单独成行。

___

效果:


在 RB 中使用

在字段中使用

可以对 多行文本 字段启用“使用富文本编辑器”选项,启用后该字段将使用 Markdown 编辑器进行编辑。

任务详情

项目 任务中,详情默认启用富文本编辑器,方便你为任务添加格式化的描述信息。

通知内容

发送通知 触发器中编写通知内容时,除短信外均支持 Markdown 格式。你可以在内容中使用粗体、列表、表格等格式,使通知内容更加清晰易读。

不同接收平台对 Markdown 的支持程度有所不同,详情请参考 发送通知 文档说明

常见问题

编辑器中没有看到某些按钮

编辑器的工具栏按钮由系统统一配置,不同场景下可能仅提供部分按钮。如果你需要更多格式,可以直接手动输入 Markdown 语法。

为什么我写的 Markdown 没有渲染

请确认你所在的字段是否启用了“使用富文本编辑器”。如果未启用,内容将以纯文本方式显示。对于通知内容,请确认接收平台是否支持 Markdown 格式。

如何在表格中显示竖线

在表格中使用 \| 转义竖线字符即可,例如 内容\|内容

如何插入换行

在 Markdown 中,连续两个以上空格后回车可以实现换行(软换行)。如果需要明确的段落分隔,请使用空行分隔两个段落。

该文档内容对你是否有帮助?没有
你也可以通过 社区群组 向我们反馈问题
更新时间 2026-09-10
目录