dsh-document-review:本地瀏覽器裏的 Markdown 審閱插件

前言

DSH 插件生態裏,很多工作圍繞智能體與本地環境協作展開。dsh-document-review 針對一個具體場景:在 DSH 中審閱 Markdown 文檔。

它把 Markdown 渲染到本地瀏覽器,讓人選中文字添加評論、建議替換或建議刪除;agent 讀取這些註釋後,再通過正常文件編輯工具修改源文件。下面介紹它的定位、安裝和用法。

這是什麼

dsh-document-review 是一個 DeepSeek Harness 插件,由 yabo083 維護,許可證爲 MIT,要求 Node >=20。

它支持審閱單個 Markdown 文件,也支持審閱整個目錄。瀏覽器審閱頁只讀渲染 Markdown,並在側欄顯示註釋;頁面不直接編輯 Markdown 源文件。

註釋集中保存在:

~/.dsh-document-review/annotations.jsonl

這是 append-only 存儲。註釋帶有 textQuote 錨點和 SHA-256 源文件哈希,用於校驗 stale。

核心功能

先說能力邊界。這個插件提供以下能力:

  • 在本地瀏覽器中審閱 Markdown 文檔。
  • 支持選中文本添加評論、建議替換和建議刪除。
  • 支持單個 Markdown 文件和整個目錄審閱。
  • 提供 document_review_start、document_review_list、document_review_update、document_review_stop 工具。

目錄模式下,它會遞歸列出 .md/.markdown 文件,跳過 node_modules、.git 和構建產物目錄,最多處理 500 個文件。

設置方面,它提供全局設置和當前工作區設置,並分層覆蓋 cordis.yml 配置:

默認值 → cordis.yml → 全局設置 → 當前工作區設置

全局設置持久化到:

~/.dsh-document-review/config.json

當前工作區設置持久化到:

~/.dsh-document-review/workspace-configs.json

入口方面,它會在 DSH 側欄 Workspace 行菜單中提供「文檔審閱」入口,並提供 /api/v2/document-review/start 等 HTTP 路由供 GUI 啓動器使用。

安裝與啓用

先安裝插件:

dsh plugin --profile web add dsh-document-review

如果是從本地 checkout 做開發安裝,先指定 cordis.yml 的絕對路徑:

dsh web --patch /absolute/path/to/dsh-document-review/cordis.yml

路徑需要按你的 checkout 位置修改。

經過上面的步驟後,可以打開:

http://127.0.0.1:3080

然後要求 agent:

Review the document at /path/to/file.md word by word.

也可以打開 Workspace 行的 ⋯ 菜單,選擇「文檔審閱」進入審閱頁。

典型用法

單文件流程:

1、打開 DSH Web 頁面。

2、把要審閱的 Markdown 路徑告訴 agent,例如:

Review the document at /path/to/file.md word by word.

3、在渲染文檔中選中一段文字。

4、選擇添加評論、建議替換或建議刪除。

5、註釋出現在側欄;agent 讀取註釋後,通過正常文件編輯工具應用修改。

目錄流程:

1、將目錄路徑傳給 document_review_start。

2、頁面列出目錄中的 .md/.markdown 文件;遞歸列出,跳過 node_modules、.git 和構建產物目錄,最多 500 個文件。

3、逐個打開文檔並添加註釋。

如果需要由 GUI 啓動器拉起,可以調用 HTTP 路由:

POST /api/v2/document-review/start

適用場景與注意

適合場景:

  • 在 DSH 工作流中審閱單個 Markdown 文件。
  • 審閱一個目錄內的多篇 Markdown 文檔。
  • 人負責標註,agent 負責讀取註釋並執行修改。

注意:

  • 瀏覽器審閱頁不直接編輯 Markdown 源文件;修改由 agent 通過正常文件編輯工具應用。
  • 插件以當前 dsh 進程權限運行,安裝前應檢查源碼與許可證。
  • 目錄模式有文件數量上限,最多 500 個文件,並跳過 node_modules、.git 和構建產物目錄。
  • 運行環境需要 Node >=20。

資源

GitHub:

https://github.com/yabo083/dsh-document-review

插件目錄頁:

https://www.skillhub.cn/plugins/yabo083/dsh-document-review
羽毛球分组比赛记分
小程序二维码

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

小夜