504 字
3 分钟
Mermaid 图表图集

Mermaid 把 Markdown 里的文本描述变成图表。下面用 Shirone 的内容工作流演示技术文章与项目笔记中常用的各类图。

流程图#

流程图描述一个过程,包括判断与回到前面步骤的路径。

flowchart TD
    accTitle: 文章发布流程
    accDescr: 一篇文章在发布前要经过撰写、校验、预览与构建;校验未通过则返回修改。
    Draft[撰写 Markdown] --> Check{校验通过?}
    Check -->|否| Revise[修改文章]
    Revise --> Check
    Check -->|是| Preview[本地预览]
    Preview --> Build[构建静态页]
    Build --> Publish[发布]

时序图#

时序图按时间顺序呈现参与者之间的协作。下面跟踪一次 Swup 站内导航,从请求到 Mermaid 渲染。

sequenceDiagram
    accTitle: 站内导航后的图表渲染
    accDescr: 读者发起导航,Swup 替换文章内容,Mermaid 渲染器在新页面增强图表。
    actor Reader as 读者
    participant Browser as 浏览器
    participant Swup
    participant Content as 文章区域
    participant Renderer as Mermaid 渲染器
    Reader->>Browser: 打开另一篇文章
    Browser->>Swup: 发起站内导航
    Swup->>Content: 替换页面内容
    Swup-->>Renderer: 触发 content:replace
    Renderer->>Content: 查找 Mermaid 容器
    Renderer-->>Browser: 插入带主题的 SVG

实体关系图#

实体关系图建模结构化数据,以及作者、文章、标签与评论之间的联系。

erDiagram
    accTitle: 博客内容关系
    accDescr: 作者撰写文章,文章接收评论,关联记录把文章连接到多个标签。
    AUTHOR ||--o{ POST : writes
    POST ||--o{ COMMENT : receives
    POST ||--o{ POST_TAG : classified_by
    TAG ||--o{ POST_TAG : groups
    AUTHOR {
        string id PK
        string display_name
    }
    POST {
        string slug PK
        string title
        datetime published_at
        string author_id FK
    }
    COMMENT {
        string id PK
        string post_slug FK
        string body
    }
    TAG {
        string id PK
        string label
    }
    POST_TAG {
        string post_slug FK
        string tag_id FK
    }

类图#

类图传达软件设计中的职责、公开方法与依赖方向。

classDiagram
    accTitle: Markdown 渲染模块
    accDescr: 内容管线用 Mermaid 插件生成回退标记,客户端渲染器再把它增强为 SVG。
    class ContentPipeline {
        +render(markdown)
        +collectMetadata()
    }
    class MermaidPlugin {
        +transform(codeFence)
        +createFallback()
    }
    class DiagramRenderer {
        +initialize()
        +renderAll()
        +refreshTheme()
    }
    class ThemeTokens {
        +primary
        +surface
        +outline
    }
    ContentPipeline --> MermaidPlugin : uses
    DiagramRenderer --> MermaidPlugin : enhances output
    DiagramRenderer --> ThemeTokens : reads

状态图#

状态图展示对象的生命周期,以及推动它在状态间迁移的事件。

stateDiagram-v2
    accTitle: 文章生命周期
    accDescr: 文章从草稿到评审再到发布,可能返回修改,最终被归档。
    [*] --> Draft
    Draft --> InReview : 提交
    InReview --> Draft : 要求修改
    InReview --> Published : 通过
    Published --> Draft : 撤回
    Published --> Archived : 归档
    Archived --> [*]

XY 图#

XY 图把柱状与折线组合,在同一坐标轴上对比数值与趋势。

xychart-beta
    accTitle: 六周内容表现
    accDescr: 柱状表示归一化的周发布量,折线表示归一化的阅读完成率。
    title "六周内容表现"
    x-axis "周" [1, 2, 3, 4, 5, 6]
    y-axis "相对得分" 0 --> 100
    bar [36, 52, 44, 68, 76, 84]
    line [48, 55, 62, 61, 73, 81]

饼图#

饼图紧凑地对比各类别对整体的贡献。

pie showData
    accTitle: 文章主题占比
    accDescr: 工程类占四成,设计系统占两成半,其余由指南与随笔平分。
    title 文章主题占比
    "工程" : 40
    "设计系统" : 25
    "指南" : 20
    "随笔" : 15

甘特图#

甘特图沿日历时间线安排任务、依赖与里程碑。

gantt
    accTitle: 主题发布计划
    accDescr: 发布计划从需求与交互设计,推进到组件开发、测试与发布。
    title 主题发布计划
    dateFormat YYYY-MM-DD
    axisFormat %m/%d
    section 设计
    确认需求 :done, brief, 2024-05-06, 2d
    细化交互 :done, interaction, after brief, 3d
    section 实现
    开发组件 :active, components, after interaction, 6d
    编写示例 :examples, after interaction, 4d
    section 验证
    自动化测试 :tests, after components, 3d
    发布 :milestone, release, after tests, 0d

思维导图#

思维导图把一个中心主题展开为相关领域与支撑概念。

mindmap
  root((Shirone))
    内容体验
      Markdown
      搜索
      图表
    界面体系
      M3E 令牌
      响应式布局
      配色方案
    工程质量
      Astro Check
      Playwright
      无障碍

时间线#

时间线在不需精确日历时长的情况下,概括重要事件或阶段。

timeline
    title Mermaid 支持的演进
    管线设计 : 识别 Mermaid 围栏
             : 保留源码回退
    客户端增强 : 按需加载运行时
               : 应用主题令牌
    可靠性 : 支持 Swup 导航
           : 验证响应式与无障碍输出

用户旅程#

用户旅程图把任务各阶段的动作、参与者与体验评分结合起来。

journey
    accTitle: 读者理解一篇技术文章
    accDescr: 读者发现文章,结合正文与图表理解它,然后探索相关主题。
    title 读者理解一篇技术文章
    section 发现
      浏览文章列表: 4: 读者
      选择一个主题: 5: 读者
    section 理解
      阅读文章: 4: 读者
      查看关系图: 5: 读者
    section 继续
      打开相关文章: 4: 读者
      收藏页面: 3: 读者

Git 图#

Git 图展示功能分支在合并回主干之前的工作进展。

gitGraph
    accTitle: Mermaid 功能分支历史
    accDescr: 功能分支先添加渲染器与测试,再合并进主分支发布。
    commit id: "base"
    branch mermaid
    checkout mermaid
    commit id: "add-renderer"
    commit id: "add-tests"
    checkout main
    merge mermaid id: "merge-mermaid"
    commit id: "release"

看板#

看板按工作流状态对任务分组,让当前进展一目了然。

kanban
  backlog[待办]
    docs[编写作者文档]
    examples[扩充示例数据]
  active[进行中]
    themes[验证主题适配]
  complete[完成]
    fallback[源码回退]
    rendering[客户端渲染]

桑基图#

桑基图用连线宽度展示流量或其他量在节点间的流动。

sankey-beta
Landing,Reading,720
Discovery,Reading,430
Reading,Explore,360
Reading,Topics,210
Reading,Outbound,140

标签内换行#

HTML 标签接受换行符,因此标签可以换行而不加宽图表。

flowchart LR
  A[第一行<br>第二行] --> B[普通标签]

每个示例都用标准的 mermaid 代码围栏。服务端保留可读的源码标记,浏览器再把它增强为跟随当前主题的 SVG。主题切换或 Swup 导航到本文时,图表会重新渲染。

第 14 篇,共 20 篇本文属于系列

分享文章

生成精美分享图或复制链接,与更多人分享本文。

继续阅读

沿着主题读

基于共同的标签与分类

换条路线

从其他文章中稳定抽取