mlosun/dsh-docs-panel

DSH WebUI 里的「随身手册」:全局 Markdown 笔记,任何工作区随时可读。

Project Overview项目介绍

dsh-docs-panel is a native plugin built exclusively for DeepSeek Harness (DSH) that adds a global Markdown document panel to the dsh-better-sidebar extension. It lets users access their locally stored personal notes, troubleshooting guides, and custom documentation directly within DSH’s sidebar, eliminating the need to switch to a separate text editor just to reference your own materials. The plugin renders all common Markdown elements with clean, consistent formatting that adapts to DSH’s light and dark themes, and includes quality-of-life features like one-click code copying and a collapsible floating outline for quick navigation.

The typical workflow starts with opening the Global Docs entry from the + menu in DSH’s sidebar. Once the panel loads, it automatically lists all Markdown files in your configured document directory, including files nested in subfolders. You can click any file to read it directly in the panel, jump between sections via the outline, edit the document in VS Code or Chrome with a single click, and change the default document directory to any local path you prefer. If your document list is empty, just add a few Markdown files to the default directory or update the configured path in the panel’s settings.

To install the plugin, you first need to install dsh-better-sidebar version 0.4.0 or higher via the DSH CLI, then install dsh-docs-panel with a second CLI command, and restart DSH to activate it. Uninstalling is also done via a single DSH CLI command, and your existing configuration is retained even after you uninstall the plugin. The plugin is licensed under the open-source MIT license, and currently the external editor open feature only works on the macOS platform.

dsh-docs-panel 是专为 DeepSeek Harness (DSH) 开发的原生侧边栏插件,依赖 dsh-better-sidebar 运行,用于在 DSH 侧边栏展示用户本地存储的全局 Markdown 文档。用户可以将自己整理的笔记、排查手册、使用说明等放在本地目录,无需切换其他编辑器即可在 DSH 侧边栏直接点开阅读,支持规整渲染 Markdown 格式,还能一键跳转外部编辑器编辑。

安装完成并重启 DSH 后,用户可以通过 DSH 侧边栏的「+」菜单打开本插件的全局文档面板,面板会自动列出指定目录下所有的 .md 文件(包括子目录中的文件),点击任意文档即可开始阅读。文档自带悬浮大纲,点击标题可平滑跳转,还支持代码块一键复制、自动适配亮色/暗色主题,适合经常需要在 DSH 开发过程中查阅自定义文档的用户使用。

本插件必须先安装版本不低于 0.4.0 的 dsh-better-sidebar 才能运行,安装顺序要求先装依赖再装本插件,目前仅在 macOS 平台支持外部打开功能。插件采用 MIT 许可证开源,默认读取 ~/.dsh/docs 目录,支持自定义修改文档目录,安装和卸载都可以通过 DSH 的 CLI 命令一行完成。

Pre-install check安装前体检Compatibility · Security兼容性 · 安全性 1 warning1 项注意
  • Only 7 stars - very few users, little community feedback星标只有 7,几乎没人在用,遇到问题缺少社区反馈
DSH walks through these 9 checksDSH 会逐条核对这 9 项

Compatibility兼容性

  • DSH, Node, OS and profile requirementsDSH 版本 / Node 版本 / 操作系统 / profile 是否满足要求
  • External dependencies and runtimes (Electron / Python / Docker, ...)外部依赖与运行时(Electron / Python / Docker 等)是否齐备
  • Conflicts with installed plugins: command names, skill / tool names, ports, duplicate MCP registration与已装插件是否冲突:命令名、skill / tool 重名、端口占用、重复 MCP 注册

Security安全性

  • Repo matches the facts registered here; archived or abandoned?仓库是否与页面登记一致,是否归档或长期停更
  • Safety of preinstall / install / postinstall and install.sh / setup.ps1preinstall / install / postinstall 与 install.sh、setup.ps1 是否安全
  • curl|bash, download-then-execute, obfuscation, unrelated domains → stop immediatelycurl|bash、下载即执行、混淆代码、无关域名 → 立刻停止
  • Typosquatting or unmaintained packages among the new dependencies新增依赖里有没有 typosquatting 或无人维护的包
  • Requested permissions vs. what the feature actually needs申请了哪些权限、是否超出功能所需(filesystem / network / shell / clipboard)
  • Any sudo / admin requirement, plus uninstall and rollback是否要求 sudo / 管理员权限,以及卸载与回滚方式

Anything uncertain must be marked unknown with a note on how to confirm it. This site's signal screen is a static snapshot, not a security audit.拿不准的必须标「未知」并说明要我怎么确认。本站的信号筛查是静态快照,不能替代安全审计。

Or use CLI install (for developers)或使用命令行安装(适合开发者)

CLI Install命令行安装

dsh plugin --profile web add dsh-docs-panel

把 mlosun/dsh-docs-panel 加入你的 DSH 配置(web profile)即可启用。

READMEREADME

dsh-docs-panel

DSH 侧边栏里的「全局文档」:全局 Markdown 笔记,任何工作区随时可读。

npm license requires platform

把你自己整理的 Markdown 笔记,直接搬进 DeepSeek Harness 的侧边栏里读。

你攒在 ~/.dsh/docs 的笔记、排查手册、使用说明,不必再切到别的编辑器——在 dsh 侧边栏点开即读:排版干净的正文、随时跳转的大纲,读完一键就能转到 Chrome 或 VS Code 继续编辑。

⚠️ 重要:依赖 dsh-better-sidebar

本插件从 v0.1.0 起作为 dsh-better-sidebar 的侧边栏页面运行,不再提供独立的右上角按钮入口。

  • 必须安装 dsh-better-sidebar(≥ v0.4.0),否则本插件无法显示、无法使用;
  • 安装顺序:先装 better-sidebar,再装本插件(见下方「安装」);
  • 界面入口位于 dsh 右侧边栏的「+」菜单与 tab 栏,与文件 / Git / 终端等页面并列。

功能一览

  • 📚 列表点选阅读:自动列出文档目录下所有 .md 文件(含子目录),点一下就读;
  • 🎨 良好排版:标题、列表、表格、代码块、引用、链接都渲染得规整,自动适配亮色/暗色主题;
  • 🧭 悬浮大纲:一键展开文档目录,点标题平滑跳转(默认收起,不打扰阅读);
  • 🌐 外部打开:每篇文档提供「Chrome 打开」「VS Code 打开」按钮,随时转到编辑器继续编辑(目前仅支持 macOS);
  • 📋 代码复制:代码块右上角一键复制;
  • 📁 目录可配置:默认读 ~/.dsh/docs,可在面板里改成任何目录,保存后永久生效;
  • 🧩 侧边栏集成:作为 better-sidebar 的一个 tab 注册,与内置页面同风格(图标、头部、按钮对齐内置),随侧边栏布局按会话持久化。

安装

第一步:安装依赖(如果还没装过):

dsh plugin --profile web add dsh-better-sidebar@latest

第二步:安装本插件:

dsh plugin --profile web add dsh-docs-panel

两条命令都会自动完成:从 npm 拉取插件包、登记到 dsh 的启动清单。装完后重启 dsh(或按 better-sidebar 的要求硬刷新浏览器 Cmd/Ctrl+Shift+R),打开网页,侧边栏「+」菜单里就有「全局文档」了。以后每次 dsh 启动都会自动加载,无需重新安装。

卸载

在终端执行一条命令:

dsh plugin --profile web remove dsh-docs-panel

然后重启 dsh 生效。卸载会保留你的文档目录配置,重新安装后依然生效。

使用

  1. 打开 dsh 侧边栏,点「+」菜单,选「全局文档」(或直接点已固定的「全局文档」tab);
  2. 左侧列表点选一篇文档,右侧阅读;
  3. ⚙️ 修改文档目录(默认 ~/.dsh/docs,保存到 ~/.dsh/storages/dsh-docs-panel/config.json);
  4. 「☰ 大纲」展开目录,「Chrome / VS Code 打开」转到编辑器。

常见问题

文档列表是空的? 往 ~/.dsh/docs 里放几个 .md 文件即可(也可以点 ⚙️ 指向你自己的目录)。

侧边栏里没有「全局文档」? 按顺序排查:

  1. 确认已安装 dsh-better-sidebar(≥ v0.4.0)且侧边栏正常显示;
  2. 确认安装顺序是先 better-sidebar 后本插件;如果顺序反了,重装一次本插件即可;
  3. 刚安装/更新过插件后,硬刷新浏览器(Cmd/Ctrl+Shift+R)再试。

没装 better-sidebar 能用吗? 不能。本插件 v0.1.0 起作为 better-sidebar 的侧边栏页面运行,未安装 better-sidebar 时插件不会显示任何界面。

开发

node markdown-test.cjs   # 自测 Markdown 渲染器

本地调试(已安装线上版时):在 ~/.dsh/profiles/web/package.json 把依赖改为 "dsh-docs-panel": "link:/绝对路径/到/本仓库",执行 pnpm install,重启 dsh 并硬刷新浏览器。

目录结构

.
├── lib/
│   ├── index.js          # 宿主端:配置、文档读取、外部打开、剪贴板、HTTP 接口
│   └── client.js         # 浏览器端:better-sidebar tab 注册、大纲、Markdown 渲染器
├── cordis.patch.yml      # dsh 启动清单补丁
├── markdown-test.cjs     # 渲染器自测(node markdown-test.cjs)
├── docs/
│   └── better-sidebar-integration.md  # 接入 better-sidebar 的改造方案(含实施记录)
├── LICENSE
└── package.json

许可证

MIT

← 上一个 Prev dsh-pdf 下一个 Next harness-lark →