前言¶
在 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 生態裏「一切皆插件」思路下的文檔閱讀客戶端擴展。