Introduction

In workflow plugins like DSH, many developers maintain a collection of Markdown notes, troubleshooting manuals, and usage guides locally. These documents are often scattered within the editor, incurring a high switching cost. dsh-docs-panel addresses this entry point issue: it displays .md files from a documentation directory in the DSH sidebar, allowing them to be opened as global documentation pages at any time.

What is it

dsh-docs-panel is a DSH web plugin maintained by mlosun under the MIT license. Since version v0.1.0, it has been running as a sidebar page within dsh-better-sidebar and no longer provides a standalone entry button in the top-right corner.

Simply put, it renders Markdown files from a specified directory into well-formatted web pages and provides auxiliary capabilities such as outline navigation, code copying, and opening in external apps.

Core Features

Document List and Reading

  • Automatically lists all .md files in the documentation directory, including subdirectories
  • Select a document on the left and read on the right
  • Supports rendering of headings, lists, tables, code blocks, blockquotes, and links
  • Automatically adapts to light/dark themes

Reading Aids

  • Expandable outline with smooth scrolling when clicking headings; collapsed by default
  • One-click copy button in the top-right corner of code blocks
  • Provides “Open in Chrome” and “Open in VS Code” buttons for each document; currently only supports macOS
  • The default documentation directory is ~/.dsh/docs, which can be changed to any directory in the panel; changes take effect permanently after saving
  • Registered as a tab in better-sidebar, persisting with the sidebar layout per session

Installation and Enablement

Dependencies

You must install dsh-better-sidebar (≥ v0.4.0). If it is not installed, this plugin cannot be displayed or used.

Installation Commands

First, install the dependency:

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

Then, install this plugin:

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

After installation, restart dsh or hard refresh the browser:

Cmd/Ctrl+Shift+R

Typical Usage

  1. Open the dsh sidebar, click the “＋” menu, and select “Global Docs”; if it is pinned, click the “Global Docs” tab directly.
  2. Click a document in the left list to read it on the right.
  3. If you need to change the documentation directory, click the settings button to modify it; it defaults to reading ~/.dsh/docs and saves to ~/.dsh/storages/dsh-docs-panel/config.json.
  4. Click “Outline” to expand the directory and click on a heading to jump.
  5. If you need to continue editing, click “Open in Chrome” or “Open in VS Code”; this capability currently only supports macOS.

Uninstallation

Execute:

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

Uninstallation preserves the documentation directory configuration, so it remains effective after reinstalling.

Applicable Scenarios and Notes

It is suitable for individuals who need to frequently check personal notes, troubleshooting manuals, and usage guides within DSH. Since the plugin reads the local documentation directory and runs with the permissions of the current dsh process, you should check the source code and the MIT license before installing.

Usage Notes:

  • You must install dsh-better-sidebar (≥ v0.4.0) before installing dsh-docs-panel
  • “Open in Chrome” and “Open in VS Code” currently only support macOS
  • The documentation directory configuration takes effect permanently after saving; uninstallation will not delete the configuration
  • The community directory in the DSH plugin ecosystem is an independent site with no official affiliation with DeepSeek or Huafang; do not interpret it as an official app store

Related Links

  • GitHub: https://github.com/mlosun/dsh-docs-panel
  • Community Directory: You can search for dsh-docs-panel in the DSH Community Directory