DeepSHPlugins
dsh-mermaid 项目预览
GITHUB / COMMUNITY PROJECT

dsh-mermaid

工具与集成TypeScriptMIT

把 DSH Web 会话消息中的 Mermaid 代码围栏渲染为惰性加载的 SVG 图表,严格消毒并跟随明暗主题。

10 StarsAKS1st 更新时间 2026-08-18
访问 GitHub 仓库
dsh-mermaid 项目预览
dsh-mermaid 界面截图dsh-mermaid 界面截图dsh-mermaid 界面截图dsh-mermaid 界面截图

项目介绍

中文

把 DSH Web 会话消息中的 Mermaid 代码围栏渲染为惰性加载的 SVG 图表,严格消毒并跟随明暗主题。

English

Render Mermaid code fences in DSH Web chat messages as lazy-loaded SVG diagrams with strict sanitization and light/dark theme follow.

项目信息与收录信号

快照 2026-09-11
作者 / 组织
AKS1st
仓库
AKS1st/dsh-mermaid
GitHub Stars
10
Forks
1
开发语言
TypeScript
许可证
MIT
最近推送
2026-08-18
Manifest
数据中检测到声明

公开仓库不自动等于可商用;许可证与当前兼容性以原项目文档为准。Manifest 和数据评分不构成安装安全认证。

数据评分

73/ 100
维护活跃
84
文档与实用信息
85
生态关注度
32
安装便捷信号
100
项目声明信号
100

README 含完整安装与使用说明;标准命令一键安装。

评分来自已有数据快照的五维模型,仅作浏览参考,不是实际使用评测或安全检测结论。

安装与使用

所有项目资料与许可均以对应 GitHub 仓库为准。

dsh plugin --profile web add github:AKS1st/dsh-mermaid

复制命令不会自动执行。请先阅读仓库文档,确认环境要求与许可证。

项目截图

仓库 README

GitHub 原文

已保存的仓库文档快照;文档抓取时间未记录,可能与上方目录介绍处于不同版本。安装前请核对当前仓库说明。

dsh-mermaid

English

在 DSH Web 会话消息中把 ``mermaid 代码围栏渲染为 SVG 图表的独立插件,通过 dsh plugin` 安装进 web profile。

效果预览

亮色主题 · 会话内(未放大)暗色主题 · 会话内(未放大)
亮色主题会话内渲染暗色主题会话内渲染
亮色主题 · 放大浮层暗色主题 · 放大浮层
亮色主题放大浮层暗色主题放大浮层

放大浮层自动适配屏幕(接近全屏、四周留白),滚轮缩放,按住左键/中键可拖动平移;theme: auto 时图表颜色跟随 GUI 亮/暗主题。

工作方式

  • Host 半部(src/index.ts):注册 webServer 前缀路由 /mermaid-dist,从插件自己的 node_modules/mermaid 惰性提供 UMD 构建,并提供固定的 config.json 端点。
  • Client 半部(src/client/):监听会话 DOM,把 infostring 为 mermaid 的围栏渲染为 SVG:
  1. 只处理已定格的围栏(流式输出期间不渲染);
  2. 首次遇到围栏才惰性加载 mermaid(浏览器缓存一次);
  3. 视口驱动渲染:围栏进入视口(带 300px 预加载余量)才开始渲染,滚到哪渲染到哪;还在排队/加载中离开视口的图会停止渲染,回到视口再继续;
  4. 异步队列渲染:多图时逐个渲染并在渲染之间让出主线程,页面不卡顿;首次渲染期间围栏位置显示加载动画,渲染完成后替换为 SVG;
  5. mermaid.render() 产出 SVG,替换围栏的 <pre> 主体,语言横幅与复制按钮保留(复制仍复制源码);
  6. securityLevel 恒为 strict,标签经 mermaid 内置 DOMPurify 消毒,且从不绑定点击处理;
  7. 主题跟随 GUI:theme: auto 读取 body[data-ds-dark-theme],属性翻转时自动重渲染视口内的既有图表(视口外的图在重新进入视口时更新);
  8. 横幅放大按钮打开全屏浮层:图表打开时自动适配屏幕(接近全屏、四周留白、垂直/水平居中),滚轮在此基础上缩放,按住左键或中键拖动可平移画面(不放大也能拖,边界自动限制不让图跑丢),背景点击或 Esc 关闭;
  9. 渲染失败可见化:首次渲染失败时保留源码块,并在图框下方显示错误摘要(超长自动截断、悬停查看全文),支持一键复制报错或发送给 AI 修复(自动把报错+源码填入输入框并发送,模拟用户将报错发给 AI)。

client 包体积约 10 KB(gzip ~4 KB);mermaid(~700 KB)只在真正出现 mermaid 围栏时才按需加载,不进入 boot 图。

安装

从 GitHub 仓库安装(构建在 prepare 脚本里自动执行):

dsh plugin --profile web add github:AKS1st/dsh-mermaid
dsh web   # 重启 web 服务使 profile 生效
若 pnpm 提示 git 依赖需要执行构建脚本(ERR_PNPM_GIT_DEP_PREPARE_NOT_ALLOWED),
按提示把包加入 profile 的 pnpm-workspace.yaml 的 allowBuilds 后重试即可。

本地开发(先构建再安装):

npm install
npm run build
dsh plugin --profile web add .
dsh web

卸载:

dsh plugin --profile web remove dsh-mermaid

配置

组合包默认生效以下配置:

- insert:
    - id: mermaid
      name: 'dsh-mermaid'
      config:
        theme: auto
        maxTextSize: 50000
        maxEdges: 2000
        securityLevel: strict
配置项默认值说明
themeauto图表主题:auto(跟随亮/暗)、default、dark、neutral、forest、base
maxTextSize50000单图文本上限(防超大图拖垮渲染)
maxEdges2000边数守卫
securityLevelstrict固定为 strict,不接受 loose

在 profile 的 cordis.patch.yml 里以 - set: 或 - update: 覆盖即可。

安全模型

  • 助手输出不可信:securityLevel 锁定 strict,标签中的 HTML 由 mermaid 内部 DOMPurify 消毒;不调用 bindFunctions,点击处理保持惰性。
  • 渲染失败时保留原纯文本代码块(绝不渲染错误 HTML),并在图框下方显示错误摘要(可复制、可一键发送给 AI 修复);控制台同时输出完整错误。

已知限制

  • 依赖主前端 CodeBlock 的稳定钩子(字面量类 md-code-block 与 infostring 文本);上游渲染器重构时需要同步更新选择器。
  • 流式输出期间不渲染,定格后才渲染。
  • securityLevel: strict 下 mermaid 的点击交互不可用。

使用前核对

安装步骤、兼容版本与授权范围以原项目当前文档为准。Stars 和评分是快照中的导航信号。

安装与排错 · 项目问题反馈

同类项目