目前在钉钉文档/代码块中,暂不支持 Mermaid 语法解析。这导致在编写技术文档、流程说明、系统架构图时,无法像 Markdown 工具(如 Typora、Obsidian、GitHub 等)一样,通过简单的文本描述自动生成流程图或时序图。
在实际使用过程中,我们需要:
先用文本写好逻辑(如流程、状态机、时序)
再手动使用绘图工具重新绘制一遍图形
这种方式存在明显问题:
效率低:重复劳动(写一遍逻辑 + 再画一遍图)
维护成本高:文案修改后,图也要手动同步更新
容易出错:文案与图不一致的情况较常见
协作不友好:代码化的图更容易做版本管理和review
期望功能
希望钉钉可以支持 Mermaid 语法,至少包括:
在代码块或文档中直接渲染 Mermaid
支持常见图类型:
流程图(flowchart)
时序图(sequenceDiagram)
类图(classDiagram)
状态图(stateDiagram)
支持实时预览或一键渲染
示例
例如以下内容:
flowchart TD
A[开始] --> B{是否通过}
B -- 是 --> C[继续流程]
B -- 否 --> D[结束]
可以自动渲染为流程图,而不是纯文本。
使用场景
技术设计文档(后端/架构)
产品流程说明
接口调用时序图
项目流程梳理
价值
提升文档效率(减少重复劳动)
提高一致性(文档即图)
更利于团队协作与版本管理
对开发者生态更友好
总结
Mermaid 已成为事实标准之一,广泛应用于开发者工具链中。希望钉钉能够尽快支持该能力,增强文档与开发协同体验。
感谢考虑 🙏
版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。