For AI agents: the complete documentation index is available at https://lazygophers.github.io/pamphlet/llms.txt, the full documentation bundle is available at https://lazygophers.github.io/pamphlet/llms-full.txt, and this page is available as Markdown at https://lazygophers.github.io/pamphlet/write/diagrams/mermaid/c4.md.
  • 简体中文
  • 系统上下文图(Mermaid 围栏)

    这是什么

    和系统上下文图画的是同一种图,区别只在怎么写:这一页用 ```mermaid 围栏,直接写 Mermaid 自己的图源。

    什么时候用

    • 源文档要发到 GitHub,并且希望在 GitHub 上也能看到图——自有写法在那边显示成一段普通文字
    • 已经会 Mermaid,不想再学一套
    • 需要自有写法表达不了的细节(下面「坑」那一节写明是哪些)

    其余情况用自有写法:字段名固定,写错了当场报错并指到具体那一行。

    怎么写

    ```mermaid
    C4Context
      title 谁在用 Pamphlet
      Person(author, "作者", "写 Markdown 的人")
      System(pamphlet, "Pamphlet", "把一份 .md 编译成一个 HTML")
      System_Ext(reader, "读者的浏览器", "双击打开产物")
      Rel(author, pamphlet, "pamphlet build")
      Rel(pamphlet, reader, "一个自包含的 HTML 文件")
    ```

    出来是什么样

    编译时就画成 SVG 内联进产物,读者那边不下载任何绘图库、也不联网。颜色跟着主题走,可以滚轮缩放、按住拖动、双击复位。

    坑

    • Person 是人,System 是自家系统,System_Ext 是外部系统(颜色会不同)
    • 第一个参数是 ID(英文),后面两个是显示的名字和说明,可以写中文
    • C4 还有 C4Container C4Component 两层,越往里越细