前言¶
在 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