问小白 wenxiaobai
资讯
历史
科技
环境与自然
成长
游戏
财经
文学与艺术
美食
健康
家居
文化
情感
汽车
三农
军事
旅行
运动
教育
生活
星座命理

用Mermaid绘制超酷流程图,提升Markdown文档颜值!

创作时间:
作者:
@小白创作中心

用Mermaid绘制超酷流程图,提升Markdown文档颜值!

引用
CSDN
13
来源
1.
https://wenku.csdn.net/answer/e86071560d0f46699564c523391e96a8
2.
https://blog.csdn.net/ftswsfb/article/details/119523080
3.
https://zhuanlan.zhihu.com/p/627356428
4.
https://tencentcloud.csdn.net/67862fe9edd0904849a4ea6e.html
5.
https://blog.csdn.net/KissedBySnow/article/details/135403534
6.
https://sspai.com/post/63055
7.
https://github.com/mermaid-js/mermaid/blob/develop/README.zh-CN.md
8.
https://mermaid.nodejs.cn/
9.
https://mermaid.nodejs.cn/intro/syntax-reference.html
10.
https://pkmer.cn/Pkmer-Docs/02-%E7%9F%A5%E8%AF%86%E7%AE%A1%E7%90%86%E5%9F%BA%E7%A1%80/mermaid/mermaid%E8%AF%AD%E6%B3%95/
11.
https://mermaid.nodejs.cn/intro/syntax-reference.html#diagram-breaking
12.
https://mermaid.nodejs.cn/config/usage.html
13.
https://mermaid.nodejs.cn/intro/

Mermaid是一款开源的低代码绘图工具,支持在Markdown文档中动态创建和修改各种类型的图表,如流程图、时序图等。通过简单的文本语言,用户可以轻松地将美观的图表嵌入到Markdown文档中,极大地提升了文档的可读性和专业度。

01

Mermaid的基本概念和优点

Mermaid是一种基于JavaScript的绘图工具,使用类似于Markdown的语法,使用户可以方便快捷地通过代码创建图表。它的主要优点包括:

  1. 易于学习和使用:Mermaid的语法简单直观,类似于Markdown,易于学习和使用。
  2. 可移植性强:用户可以轻松地将图表定义嵌入到任何支持HTML、Markdown或AsciiDoc的文档中。
  3. 支持多种图表类型:包括流程图、序列图、甘特图、类图、饼图等多种图表类型。
  4. 实时预览和编辑:通过在线编辑器,用户可以实时查看图表的渲染效果。
02

如何在Markdown中使用Mermaid

要在Markdown文档中使用Mermaid,你需要确保所使用的Markdown编辑器支持Mermaid语法。以下是一些常用的Markdown编辑器:

  1. Typora:支持Mermaid语法,可以在实时预览中查看图表效果。
  2. VSCode:需要安装Mermaid插件(如"Markdown Preview Mermaid Support")才能支持Mermaid图表。
  3. FlowUs 息流:兼容Markdown语法,支持Mermaid代码的渲染。
  4. GitLab:支持Mermaid图表的渲染。

使用Mermaid的基本步骤如下:

  1. 在Markdown文档中插入代码块,并将语言标识设置为"mermaid"。
  2. 在代码块中使用Mermaid的语法编写图表定义。
  3. 保存文档并预览,查看渲染后的图表效果。
03

常用图表类型的语法示例

1. 流程图(Flowchart)

流程图用于展示过程、决策和操作流程。以下是一个简单的流程图示例:

graph TD
    A[开始] --> B[步骤1]
    B --> C{决策}
    C -- 是 --> D[步骤2]
    C -- 否 --> E[结束]

2. 时序图(Sequence Diagram)

时序图用于展示对象之间的交互顺序。以下是一个简单的时序图示例:

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!

3. 甘特图(Gantt Diagram)

甘特图用于展示项目计划和进度。以下是一个简单的甘特图示例:

gantt
    dateFormat  YYYY-MM-DD
    title Adding GANTT diagram functionality to mermaid

    section A section
    Completed task            :done,    des1, 2014-01-06,2014-01-08
    Active task               :active,  des2, 2014-01-09, 3d
    Future task               :         des3, after des2, 5d
    Future task2              :         des4, after des3, 5d

    section Critical tasks
    Completed task in the critical line :crit, done, 2014-01-06,24h
    Implement parser and jison          :crit, done, after des1, 2d
    Create tests for parser             :crit, active, 3d
    Future task in critical line        :crit, 5d
    Create tests for renderer           :2d
    Add to mermaid                      :1d

    section Documentation
    Describe gantt syntax               :active, a1, after des1, 3d
    Add gantt diagram to demo page      :after a1  , 20h
    Add another diagram to demo page    :doc1, after a1  , 48h

4. 类图(Class Diagram)

类图用于展示类的结构和关系。以下是一个简单的类图示例:

classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label

04

工具推荐和使用步骤

Mermaid Live Editor

Mermaid Live Editor是一个在线编辑器,可以实时预览和编辑Mermaid图表。使用步骤如下:

  1. 打开Mermaid Live Editor网站。
  2. 在左侧编辑区粘贴或输入Mermaid代码。
  3. 实时预览效果会显示在右侧。

Typora

Typora是一个支持Mermaid语法的Markdown编辑器,可以实现实时预览。使用步骤如下:

  1. 下载并安装Typora。
  2. 打开Typora,创建一个新的Markdown文档。
  3. 在文档中插入Mermaid代码块。
  4. 保存文档并预览,查看渲染后的图表效果。

VSCode

VSCode需要安装Mermaid插件才能支持Mermaid图表。使用步骤如下:

  1. 打开VSCode,进入扩展插件市场。
  2. 搜索并安装"Markdown Preview Mermaid Support"插件。
  3. 重启VSCode。
  4. 打开Markdown文档,插入Mermaid代码块。
  5. 使用Markdown预览功能查看图表效果。
05

实用技巧和常见问题解决方案

实用技巧

  1. 换行问题:在某些Markdown编辑器中,Mermaid代码中的换行可能需要使用\n<br>来实现。例如,在Typora中可以使用\n<br>,而在GitLab中则需要使用<br>

  2. 图表主题:可以通过配置Mermaid的主题来改变图表的外观。例如,可以在Markdown文档的头部添加以下代码来设置主题:

    <style>
    .mermaid {
      --mermaid-theme: forest;
    }
    </style>
    

常见问题解决方案

  1. 图表无法显示:确保Mermaid代码语法正确,检查Markdown编辑器是否支持Mermaid,或者尝试使用Mermaid Live Editor在线预览。

  2. 依赖安装失败:如果在使用Mermaid Live Editor时遇到依赖安装失败的问题,可以尝试清除缓存(运行yarn cache clean),或者检查网络连接是否正常。

  3. 本地服务器无法启动:如果在运行yarn dev命令后无法启动本地服务器,可以检查端口占用情况(使用netstat -ano | findstr :1234命令),或者尝试重新安装依赖。

通过以上内容,相信你已经掌握了Mermaid的基本使用方法和技巧。无论是软件开发人员还是内容创作者,掌握Mermaid都能显著提高工作效率。快去尝试在你的Markdown文档中添加一些美观的图表吧!

© 2023 北京元石科技有限公司 ◎ 京公网安备 11010802042949号