前言¶
在 DSH 里做智能体或插件开发时,文档往往分散在仓库的 docs/ 目录和 preset 技能库路径里。用外部编辑器或静态站点打开,和当前 Web 工作台是两套界面,检索和文档之间的引用关系也不直观。
dsh-docs-reader 是社区维护的 客户端插件(维护者 als3453),在 DSH Web 左侧边栏增加「开发文档」入口,把目录树、Markdown 阅读、全文搜索和知识图谱放在同一面板里。文档数据不随插件打包,而是动态读取运行环境中 dsh 仓库的 docs/ 与技能库目录;仓库文档更新后,重启 dsh web 即可生效。
这是什么¶
- 名称:
dsh-docs-reader(Cordis 插件 id 同为dsh-docs-reader) - 分类:客户端(
dsh.client.platform: web) - 定位:DSH 开发文档阅读器与知识图谱插件
- 仓库:github.com/als3453/dsh-docs-reader(MIT,package 版本 1.0.0)
- 目录页:skillhub.cn/plugins/als3453/dsh-docs-reader(社区插件目录,与 DeepSeek / 幻方无官方从属关系)
Host 侧由 index.js 提供 DocsReader 服务(扫描、读取、搜索 docs);Client 侧由 client.js 注册侧边栏入口、主面板与内联 ECharts 图谱。
核心功能¶
以下能力均来自插件 README 说明:
- 入口:左侧边栏底部「开发文档」(
sidebar.panellist槽位) - 目录树:分组折叠、层级缩进;中英文标题按文档语言显示
- 阅读:Markdown 渲染(代码块、表格、标题层级、中英切换)
- 搜索:全文搜索,匹配标题与路径
- 知识图谱:ECharts 5.5.1 内联、离线可用——总览力导向图 → 点击节点高亮节点与边 → 右侧预览摘要 → 引用关系浏览
- 右侧栏:本页目录、路径、引用文档、「被以下文档引用」(点击跳转定位)
安装与启用¶
当前仅支持 GitHub 或本地路径安装;插件尚未发布到 npm registry,因此 dsh plugin add dsh-docs-reader(npm 包名方式)暂不可用。
方式 A:从 GitHub 安装(推荐)¶
插件为纯 JavaScript、无构建脚本,git 安装即用,无需 pnpm 构建授权。
dsh plugin --profile web add github:als3453/dsh-docs-reader
安装后重启 dsh web。若你的 profile 名不是 web,先用 dsh profile list 查看,再把命令中的 web 换成实际 profile 名。
方式 B:本地路径安装¶
从 GitHub 下载 ZIP 解压后,将解压后的文件夹路径填入 <解压路径>(适合离线或本地调试):
dsh plugin --profile web add link:<解压路径>
方式 C:DSH 内 install_bundle¶
在 DSH 中调用插件管理工具:
plugin_manager → action: install_bundle → target: <插件包绝对路径>
安装后确认行已激活(application: applied),侧边栏底部应出现「开发文档」入口。
数据源与配置¶
插件默认读取插件包所在仓库(相对插件包路径)的两个数据源:
| 数据源 | 默认路径 | 说明 |
|---|---|---|
| 开发文档 | ../../docs/ |
仓库 docs 目录 |
| 技能库 | ../../packages/preset/agent-preset/skills/ |
内置 Skill 文档(SKILL.md + references) |
可通过 config.root / config.skillsRoot 覆盖(相对或绝对路径均可),写在插件行的 patch 层或 profile 的 cordis.patch.yml 中,例如:
- override:
- id: dsh-docs-reader
config:
root: /path/to/deepseek-harness/docs
skillsRoot: /path/to/deepseek-harness/packages/preset/agent-preset/skills
典型用法¶
- 按上文任选一种方式安装并重启 dsh web。
- 在左侧边栏底部打开「开发文档」,在目录树中选择一篇 Markdown 文档阅读。
- 使用搜索框按标题或路径定位文档。
- 切换到知识图谱视图,点击节点查看高亮关系与右侧摘要,再通过「引用文档 / 被引用」在右侧栏跳转。
卸载示例:
dsh plugin --profile <name> remove dsh-docs-reader
或在 DSH 内使用 plugin_manager → remove_bundle。
适用场景与注意¶
适合:已在本地或部署环境中运行 DSH Web,希望在不离开工作台的前提下浏览本仓库 docs/ 与 preset 技能库文档,并查看文档间引用关系的开发者。
兼容性(README 说明):
- 依赖
@deepseek-ai/dsh-typert-protocol、@deepseek-ai/dsh-api-gateway,由 dsh 安装解析,插件包不单独声明依赖。 - 样式使用
--dsw-alias-*主题 token 与深色兜底,适配宿主明暗主题;未引入 Harness Client 包。
安全与权限:插件以当前 dsh 进程权限运行,会读取你配置的 root / skillsRoot 路径下的文件。安装前请阅读 仓库源码 与 LICENSE(MIT),确认路径与数据来源符合你的环境策略。
结尾¶
dsh-docs-reader 把 DSH 仓库内的开发文档和技能库文档接到 Web 侧边栏,并补上搜索与知识图谱,适合作为 DSH 生态里「一切皆插件」思路下的文档阅读客户端扩展。