mermaid

Mermaid 是一款基于 JavaScript 的图表和绘图工具，它使用受 Markdown 启发的文本定义和渲染器来创建和修改复杂的图表。其主要目的是通过使图表能够以文本形式轻松修改，从而让文档能够跟上开发的进度。该项目在 MIT 许可证下开源，并作为 npm 包分发。 README 列出了对 20 多种图表类型的支持，包括 Flowchart（流程图）、Sequence（时序图）、Class（类图）、State（状态图）、ER（实体关系图）、Gantt（甘特图）、Pie（饼图）、Git Graph（Git 图）、Mindmap（思维导图）、Timeline（时间线）和 Sankey（桑基图）。图表是以文本形式编写而非使用拖拽工具绘制的，因此它们可以与代码共存并通过版本控制进行审查。该项目在 mermaid.live 提供用于原型的实时编辑器，且 GitHub 的 Markdown 中原生支持渲染 Mermaid 代码块。它还提供与其他应用程序和文档工具的集成。 自定义选项包括主题、颜色、字体和布局方向。为了安全起见，Mermaid 内置了清理功能和沙箱渲染模式，在该模式下，图表在沙箱 iframe 中渲染，以防止用户内容中嵌入的 JavaScript 执行。README 指出，此模式在拦截潜在恶意代码的同时，也可能会屏蔽某些交互功能。该项目自称为轻量级且无沉重依赖，并拥有一个发布频繁的活跃社区。 相关项目包括命令行界面（CLI）、实时编辑器（Live Editor）和 HTTP 服务器。仓库的 README 还引用了官方文档、入门指南、CDN 可用性、教程和贡献指南。Mermaid 在 2019 年的 JS 开源奖中获得了“最令人兴奋的技术应用”类别奖项。