dsh-mermaid:在 DSH Markdown 中渲染 Mermaid 图表

前言

在 DeepSeek Harness(DSH)里写说明、设计文档或对话记录时,流程图、时序图往往用 Mermaid 写在 Markdown 代码块里。默认渲染通常只显示源码,阅读时要自己在脑里「编译」一遍。若希望界面里直接看到图,需要在客户端侧挂一层渲染逻辑。dsh-mermaid 就是面向这一点的 DSH 客户端插件:把 Markdown 里带 mermaid 语言标记的围栏代码块交给 Mermaid 引擎画出图。

这是什么

dsh-mermaid 由维护者 bosenok 发布,归类为客户端插件。一句话定位:在 DSH 的 Markdown 视图中,将 Mermaid 围栏代码块渲染为可读的图表。

实现上它是一个标准 DSH bundle:package.json 声明 dsh.bundle.patch,由 cordis.patch.yml 向当前激活的 profile 插入 mermaid 相关配置;Web 端客户端逻辑由 lib/client.js 提供(dsh.client.platform: web)。包版本为 0.1.0,许可证 MIT,要求 DSH 版本 >=0.2.1-rc.2 且 <0.3.0(见 package.json 的 engines.dsh)。

核心功能

下面是目前能从仓库说明核实的能力,不展开未在资料中出现的配置项。

  1. 识别 Mermaid 围栏块:在 DSH Markdown 中处理语言为 mermaid 的 fenced code block,并渲染为图表(与 README 简介一致)。
  2. 客户端 Web 挂载:通过 bundle patch 接入运行中的 DSH 应用;启用后由客户端脚本完成渲染(lib/client.js)。
  3. 与 DSH 插件机制对齐:支持桌面端插件页、CLI 安装及本地路径安装;开发态下 HMR 可作用于已运行的应用。

构建侧说明:可分发产物在 lib/;源码在 src/,客户端需经 Vite 构建(npx vite build)再由 build/wrapper.js 生成 lib/client.js。第三方依赖与许可见仓库中的 THIRD_PARTY_NOTICES.md(开发依赖中包含 mermaid ^12.2.0)。

安装与启用

安装命令以 GitHub README 为准,不要自行改写仓库路径。

桌面应用

  1. 打开 Plugins,安装 github:bosenok/dsh-mermaid。
  2. 若仓库为私有,需先让本机具备 git 访问权限。
  3. 安装后在界面中启用 bundle。

命令行

dsh plugin --profile <profile> add github:bosenok/dsh-mermaid

将 <profile> 换成你实际使用的 profile 名称。

本地目录(开发或自改版本)

dsh plugin --profile <profile> add file:/path/to/dsh-mermaid

将 /path/to/dsh-mermaid 换成本机 checkout 路径。

启用 bundle 后插件会挂载到 DSH;热更新(HMR)可作用于正在运行的应用。若客户端半部分未更新,README 建议重启应用,以便客户端重新构建并加载。

desktop profile 注意

对应用托管的 desktop profile,dsh plugin --profile desktop add 只会安装依赖并复制包,不会像普通 profile 那样自动启用 bundle。需要任选其一:

  • 在 ~/.dsh/profiles/desktop/package.json 的 dsh.profile.bundles 中加入该包名;或
  • 在桌面端 Plugins 页面启用。

其他 profile 在安装后一般会自动启用已安装的 bundle。

典型用法

资料未给出单独的配置文件示例;用法即:在 DSH 会展示的 Markdown 里书写标准 Mermaid 围栏块,语言标记为 mermaid。插件在客户端识别并渲染。

在 Markdown 正文中写入围栏代码块,首行语言标记为 mermaid,例如:

```mermaid
flowchart LR
  A[Markdown] --> B[dsh-mermaid]
  B --> C[图表]
```

在对话、笔记或插件自带的 Markdown 预览中,若 bundle 已启用且 DSH 版本满足 engines 要求,对应块应显示为图而非纯文本。

适用场景与注意

适合谁

  • 经常在 DSH 里写架构说明、流程、状态机,并已习惯用 Mermaid 表达结构的开发者。
  • 希望在 Harness 界面内直接看图、减少复制到外部 Mermaid 编辑器的人。

使用前建议

  1. 权限与信任:插件随当前 DSH 进程在本地运行,会参与 Markdown 的客户端渲染。安装前宜浏览 GitHub 仓库 源码与 MIT 许可证,并知悉 lib/ 内捆绑的第三方组件(见 THIRD_PARTY_NOTICES.md)。
  2. 版本匹配:engines.dsh 限定在 0.2.x 的 RC 段之上、0.3.0 之下;升级 DSH 主版本前需确认插件是否已跟进。
  3. 私有仓库:通过 github:bosenok/dsh-mermaid 安装时,私有库需本机 git 凭证可用。
  4. 生态说明:DSH 社区插件目录(如 SkillHub 上的条目)由社区维护,与 DeepSeek / 幻方无官方从属关系;安装来源以你信任的目录页或 GitHub 为准。

结尾

dsh-mermaid 把「Mermaid 写在 Markdown 里」和「在 Harness 里直接看图」接在一起,改动集中在客户端 bundle,安装与启用方式与 DSH 其它插件一致。需要进一步了解说明或提交 issue,可访问:

羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

Xiaoye