代码改变世界

以后就用它了,mermaid

2023-01-04 15:33  轩脉刃  阅读(3458)  评论(0编辑  收藏  举报

之前我画流程图一直是使用plunuml。但是昨天我发现typora竟然不支持。typora支持的是一种叫mermaid的语法。然后我又研究了一下,iwiki也支持这种语法。

Mermaid是一种开源的可交互式的数据可视化库,它使用 Markdown 标记语言来生成图表和流程图。它通常用于生成网站或文档中的图表。Mermaid 不属于任何公司,而是一个由社区开发和维护的开源项目。

学习 Mermaid 的好方法是访问它的官方网站,其中包含了详细的文档和教程。

官方网站:https://mermaid-js.github.io/

在这里,你可以找到有关 Mermaid 的基础知识、语法和用例的信息。此外,你还可以在该网站的“Examples”部分找到各种示例图表和流程图,以及如何使用 Mermaid 创建它们的代码。

此外,你还可以在网上搜索其他学习资源,例如博客文章、视频教程和其他文档。这样,你就可以找到适合你的学习方式和需求的资源。

Mermaid 和 PlantUML 是两种用于生成图表和流程图的工具。它们之间有一些主要的区别:

  • 语言:Mermaid 使用 Markdown 标记语言来描述图表和流程图,而 PlantUML 使用自己的独特语言。
  • 支持的图表类型:Mermaid 支持的图表类型更为丰富,包括流程图、甘特图、序列图、用例图、类图和关系图。PlantUML 只支持流程图、序列图、用例图、类图和对象图。
  • 运行环境:Mermaid 可以在浏览器中直接运行,也可以使用 Node.js 在服务器端生成图表。PlantUML 只能在服务器端运行,并使用 Graphviz 库生成图表。

总的来说,Mermaid 更为简单易用,适合快速制作网站或文档中的图表。PlantUML 功能更为强大,适合更复杂的图表和模型。

昨天我用mermaid做了一个技术文档,发现typora和iwiki都支持的非常好,且绘制的更为漂亮。

我使用了Class Diagram画了一个类图,然后使用Sequence Diagram画了一个时序图。能非常清晰把我要说的东西都描述清楚,语法从PlantUML迁移过来基本没有啥不适成本。

后续我就转型选择使用mermaid来进行文档编写了。