メインコンテンツへスキップ
F

dsh-markdown-docs

femnn/dsh-markdown-docs

Markdown workbench in the right sidebar: lists the Markdown files of the session workspace, previews and edits them with a version-checked save, opens a file or folder dropped on the page (a skill directory included), and links the documents a file references so they open in the same panel.

インストール

dsh plugin --profile web add github:femnn/dsh-markdown-docs

README

Markdown documents

A DeepSeek Harness plugin that puts a Markdown workbench in the right sidebar: drop a file or a folder on it, read and edit documents, and jump to the documents a skill file references.

Where to find it

Open the right sidebar, then the guide page: the Markdown documents capsule opens this page. The capsule carries a page-and-pencil glyph.

Drop something on it

  • A file opens it for reading and editing, and the list behind it moves to that file's folder, so ← leads to its siblings.
  • A folder lists the Markdown documents inside it. Dropping a skill directory is the fastest way in: the list shows SKILL.md and everything under references/.
  • A file the platform cannot locate on disk (a plain browser tab without the Desktop path bridge) still opens, read-only, from the bytes the browser received; the status bar says so.

In the Desktop app the preload exposes __DSH_HOST_PATHS__.pathFor, which maps a dropped File to its absolute path; without it the panel can read a dropped file but not write it back.

What it does

  • Lists every .md, .markdown, and .mdx file under the chosen folder, sorted by path. Dependency and build directories (node_modules, dist, build, .git, …) are skipped, the walk stops at 400 files, 800 directories, and 6 levels, and dot-prefixed entries are ignored.
  • Previews Markdown with headings, emphasis, inline code, fenced code, lists, quotes, tables, rules, and links. Images appear as a labelled placeholder.
  • Edits in a plain-text editor with ⌘/Ctrl + S to save. A non-Markdown file opened from a reference (a .py, .yaml, .sh, …) opens in source mode and is shown verbatim, never rendered as Markdown.
  • Saves with a version guard: if the file changed on disk after you opened it, the save is refused with conflict instead of overwriting someone else's work.
  • Creates new documents with +, refusing to overwrite an existing file.
  • Links references in place: a Markdown link, an inline code span, or a bare path in prose that names a real document becomes clickable inside the rendered text and opens that document in the same panel. A path that does not exist is struck through and marked 缺失, so a broken skill reference is visible instead of silent.
  • Keeps the reference list folded: the 引用的文档 N row under the header stays collapsed by default; opening it lists every referenced document — the missing ones included — as its own quick-jump list.

Limitations

  • Reads may leave the workspace; writes are decided by the session's sandbox policy (read-only, workspace-write plus any additional writable roots, or danger-full-access) and enforced by the filesystem backend. A skill folder under ~/.dsh/skills is read-only in a workspace-write session, and the panel shows 只读 instead of failing the save.
  • Files larger than 2 MiB are not opened here.
  • The open document is not watched for external edits: if the agent rewrites the file while you have it open, saving reports conflict. Use ← to go back and reopen it.
  • Closing the tab discards an unsaved draft; the tab type keeps its body mounted across collapsing and docking, but not across closing. The status bar shows 有未保存的修改 while a draft differs from disk.
  • The reference list is a scan of the file's text, not a resolved document graph: it reads the paths a document names, in reading order, and stops at 40 entries.
  • The plugin is a UI over files on disk. It adds no agent tool; the agent already reads and edits files with its own tools.

How it is built

  • index.js is the Host half. It registers six POST routes under /api/dsh-markdown-docs on the Connection carrier — list, stat, open, save, create, references — over ctx.fs, ctx.sessions, and ctx.sandboxPolicy. The browser never picks a root: the Session header supplies the workspace, and the policy supplies the write boundary.
  • client.js is the browser bundle. It registers a right-sidebar tab type through ctx.sidebarRightTabs plus its body in the sidebar.right.pane.tab seat, and calls the routes with fetch. Styling uses only --dsw-alias-* theme tokens.

関連プラグイン