mermaid - 用于生成流程图、序列图、类图、甘特图和git图的Markdownish语法。

21-09-24 banq

Mermaid 可让您使用文本和代码创建图表和可视化效果。它是一种基于 Javascript 的图表和图表工具,可呈现受 Markdown 启发的文本定义以动态创建和修改图表。如果您熟悉 Markdown,那么学习Mermaid's Syntax应该没有问题。

Mermaid 的主要目的是帮助可视化文档,并帮助文档编写速度赶上开发。作为一种基于文本的图表工具,可以快速轻松地进行更新,它也可以作为生产脚本(和其他代码)的一部分,使文档变得更加容易。

即使是非程序员也可以通过实时编辑器创建图表。

Mermaid 被提名并获得JS 开源奖(2019 年) “最令人兴奋的技术使用”类别。

 

流程图

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

UML时序图

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!

猜你喜欢