2026.11.20 12:39
投光社区支持 Mermaid 流程图吗?
文章来源:AFFiNE
投光社区支持 Mermaid 流程图。用户可直接在内容中写入 Mermaid 代码,渲染流程图和时序图,本文说明支持范围、写法示例与注意事项。
投光社区支持 Mermaid 流程图。按照现有功能说明,用户可以直接在内容中写入 Mermaid 代码,由系统渲染为流程图和时序图,无需另外绘制图片再上传。
这种方式适合描述操作步骤、审批路径、多方之间的消息往来等内容。Mermaid 代码以文本形式保存,后续修改只需调整代码行,不必重新制图。
一、支持的图形类型
目前可确认的两类图形如下,本文仅围绕这两类展开说明。
| 图形类型 | 代码关键字 | 适用内容 |
|---|---|---|
| 流程图 | flowchart | 步骤流转、判断分支、审批路径 |
| 时序图 | sequenceDiagram | 多个角色之间的消息顺序、调用先后 |
二、流程图写法示例
以下代码描述一条简单的内容审核流程,TD 表示图形由上至下排列。
flowchart TD A["提交内容"] --> B{"审核是否通过"} B -->|通过| C["发布内容"] B -->|不通过| D["退回修改"] D --> A其中,方括号 [ ] 表示普通步骤,花括号 { } 表示判断节点,|文字| 用于标注分支条件。
三、时序图写法示例
时序图以参与者为纵向线条,消息按时间顺序自上而下排列。下面的代码展示用户、社区与审核人员之间的消息往来。
sequenceDiagram participant U as 用户 participant S as 社区 participant R as 审核人员 U->>S: 提交内容 S->>R: 转交审核 R-->>S: 返回审核结果 S-->>U: 通知发布状态实线箭头表示发起请求,虚线箭头表示返回结果。participant 行可为角色设置简称和显示名称,后续引用简称即可。
四、写入时的注意事项
- 节点文字含括号、冒号、逗号等符号时,建议使用双引号包裹,例如 A["提交(含附件)"]。
- 同一角色在时序图中应保持统一名称,避免写成多个不同名字而生成多个节点。
- 写入位置以编辑器提供的 Mermaid 入口为准。若图形未正常显示,应先检查关键字、箭头和括号是否成对,再核对文字内容。
- 流程较长时,可拆分为多张图,分别说明不同环节,便于读者阅读。
Mermaid 为开源项目,采用 MIT 许可证,完整的流程图与时序图语法可参考其官方文档()。
五、判断标准回顾与行动建议
判断一段 Mermaid 代码能否正常渲染,可以对照三点:图形关键字是否正确,箭头与节点是否成对,含特殊符号的文字是否已正确包裹。
- 先使用上文示例代码完成一次渲染,确认页面支持后再替换为实际流程。
- 每次修改后预览一次,检查分支条件与箭头方向是否符合实际业务。
- 流程发生变化时,同步更新代码,保证文字说明与图形内容一致。
文章来源:AFFiNE
风险提示及免责条款
[温馨提示] 文章来源于AFFiNE,转载注明原文出处,此文观点与查生意无关,理性阅读,版权属于原作者若无意侵犯媒体或个人知识产权,请联系我们,本站将在第一时间删掉 ,查生意仅提供信息存储空间服务。


