前言¶
在 DSH(DeepSeek Harness)開發流程中,開發者經常需要在側邊欄查看 Markdown 文檔(如提示詞模板、配置說明、開發日誌)。默認情況下,側邊欄僅顯示純文本,閱讀體驗較差,且頻繁切換編輯/預覽模式影響效率。dsh-md-viewer 插件通過接管文件打開行爲,直接在 dsh-better-sidebar 中提供富渲染預覽。
插件簡介¶
dsh-md-viewer 是一個客戶端 Web 插件,由 2017java 維護。它通過依賴 dsh-better-sidebar 的服務,將 .md 文件以富渲染視圖展示,支持代碼高亮、表格、目錄導航等功能。
核心功能¶
- 完整 Markdown 渲染:支持標題、段落、列表、引用、分隔線、鏈接、圖片、管道表格等基礎語法。
- 代碼塊增強:支持 js/ts/py/bash/json/yaml/html/css 語言的語法高亮;提供一鍵複製按鈕和語言徽標。
- 目錄與導航:自動生成目錄(TOC),點擊目錄項可平滑滾動至對應位置。
- HTML 處理與安全:正確解析
<img>、<a>、<br>等元素,處理 HTML 實體,剝離 HTML 註釋。採用純 React 渲染,不使用innerHTML,避免 XSS 風險。 - 對話聯動:在對話中點擊 DSH 自帶的“產出文件” chips,可直接在側邊欄打開並渲染預覽。
安裝與啓用¶
本插件依賴 dsh-better-sidebar。在安裝前請確保已安裝該組件。
- 安裝插件:
dsh plugin --profile web add dsh-md-viewer@latest
- 安裝完成後,在瀏覽器中執行硬刷新(Cmd/Ctrl + Shift + R)以加載新模塊。
典型用法¶
- 文件預覽:在
dsh-better-sidebar中打開任意.md或.markdown文件,即可看到排版好的富文本預覽。 - 對話聯動:在對話流中,當模型輸出文件或你點擊“產出文件” chips 時,會自動調用該插件在側邊欄渲染預覽。
限制與注意事項¶
- 依賴要求:必須安裝
dsh-better-sidebar。若未安裝,本插件不會生效(作爲安全 no-op)。 - 圖片路徑:Markdown 中的相對路徑圖片不會自動根據文件目錄解析,需在組件中基於
props.path重寫 src。 - 功能缺失:不支持 GFM 任務列表、LaTeX 數學公式、Mermaid 圖表、腳註。如需完整功能,可考慮使用
dsh-md-overlay獨立預覽組件。
總結¶
dsh-md-viewer 爲 DSH 用戶在側邊欄查看 Markdown 文檔提供了簡潔、安全且功能豐富的方案。通過標準化的文件查看器註冊機制,它無縫融入現有的側邊欄工作流。