前言¶
在 DSH 這類插件化工作流裏,很多開發者會在本地維護一批 Markdown 筆記、排查手冊和使用說明。這些文檔通常散落在編輯器裏,切換成本不低。dsh-docs-panel 解決的是這個入口問題:把文檔目錄裏的 .md 文件顯示在 DSH 側邊欄中,作爲全局文檔頁隨時打開。
這是什麼¶
dsh-docs-panel 是 mlosun 維護的 DSH web 插件,許可證爲 MIT。它從 v0.1.0 起作爲 dsh-better-sidebar 的側邊欄頁面運行,不再提供獨立的右上角按鈕入口。
簡單來說,它把指定目錄中的 Markdown 文件以排版規整的網頁形式展示出來,並提供大綱跳轉、代碼複製、外部打開等輔助能力。
核心功能¶
文檔列表與閱讀¶
- 自動列出文檔目錄下所有
.md文件,包含子目錄 - 左側點選文檔,右側閱讀
- 支持標題、列表、表格、代碼塊、引用、鏈接渲染
- 自動適配亮色 / 暗色主題
閱讀輔助¶
- 可展開大綱,點標題平滑跳轉;默認收起
- 代碼塊右上角一鍵複製
- 每篇文檔提供「Chrome 打開」「VS Code 打開」按鈕,目前僅支持 macOS
- 文檔目錄默認
~/.dsh/docs,可在面板裏改成任何目錄,保存後永久生效 - 作爲
better-sidebar的一個 tab 註冊,隨側邊欄佈局按會話持久化
安裝與啓用¶
依賴¶
必須安裝 dsh-better-sidebar(≥ v0.4.0)。未安裝時,本插件無法顯示、無法使用。
安裝命令¶
先安裝依賴:
dsh plugin --profile web add dsh-better-sidebar@latest
再安裝本插件:
dsh plugin --profile web add dsh-docs-panel
安裝完成後重啓 dsh,或硬刷新瀏覽器:
Cmd/Ctrl+Shift+R
典型用法¶
1、打開 dsh 側邊欄,點「+」菜單,選「全局文檔」;如果已固定,直接點「全局文檔」tab。
2、在左側列表點選一篇文檔,在右側閱讀。
3、需要更換文檔目錄時,點設置按鈕修改;默認讀取 ~/.dsh/docs,保存到 ~/.dsh/storages/dsh-docs-panel/config.json。
4、點「大綱」展開目錄,點標題跳轉。
5、需要繼續編輯時,點「Chrome 打開」或「VS Code 打開」;該能力目前僅支持 macOS。
卸載¶
執行:
dsh plugin --profile web remove dsh-docs-panel
卸載會保留文檔目錄配置,重新安裝後依然生效。
適用場景與注意¶
適合需要在 DSH 中頻繁查閱個人筆記、排查手冊、使用說明的人。由於插件會讀取本地文檔目錄,並以當前 dsh 進程權限運行,安裝前應檢查源碼和 MIT 許可證。
使用時注意:
- 必須先安裝
dsh-better-sidebar(≥v0.4.0),再安裝dsh-docs-panel - 「Chrome 打開」「VS Code 打開」目前僅支持 macOS
- 文檔目錄配置保存後永久生效,卸載不會刪除配置
- DSH 插件生態中的社區目錄是獨立站點,與 DeepSeek / 幻方無官方從屬關係,不要把它理解爲官方應用商店
相關地址¶
- GitHub:https://github.com/mlosun/dsh-docs-panel
- 社區目錄:可在 DSH 社區目錄中搜索
dsh-docs-panel