Roland0511/dsh-marktext

dsh-marktext

Write Markdown the way it will look.
MarkText's editor engine, living in the DeepSeek Harness right sidebar.

English · 简体中文

Click a .md and it opens as the document it will become — headings, tables, math, diagrams and images, all editable where they stand. Fix a sentence, delete a paragraph, or select the part you want to talk about and quote it into the chat. No split pane, no source-and-preview dance. ⌘S saves through a version guard, so you never overwrite someone else's edit.

MarkText is an Electron desktop app. This plugin doesn't ship its shell — it takes the editor core MarkText extracts (@muyajs/core / muya, MIT) and adds only the DSH integration. Everything runs locally.

Why it feels different

• ✍️ You edit the document, not the source. Markdown markers stay hidden; headings, lists, tables and quotes are real elements. Put the caret in a table cell and fix the cell, not a row of pipes.
• 💬 Quote straight into the chat. Select any text, hit Quote in the toolbar, and a Markdown blockquote — with the file path on top — is appended to the composer draft. No retyping, no "the third bullet under section 2".
• 📄 Export a real PDF. PDF in the toolbar (or ⌘P) turns the open document into an A4 .pdf, writes it next to the file and opens it in the sidebar so you can check the result — no print dialog, no download prompt, no "Save as PDF" detour. The document is re-laid out at page width first, so text is a normal size instead of a sidebar-width strip, and pages break on blank rows so a line of text is never sliced in half.
• 📊 Diagrams and math just render. KaTeX, Mermaid, Vega and PlantUML ship with the plugin and load on demand — offline, no CDN, no account.
• 🖼️ Images land where you expect. ![](assets/diagram.png) resolves against the document's own folder, so docs written in your editor look right here.
• 💾 Saving is boring, in the best way. Autosave 2.5 s after you stop typing; ⌘S saves immediately; a changed file on disk means a conflict banner, never a silent overwrite.
• 🌗 It looks like DSH. Light and dark follow the host, and the editor never adopts a foreign theme.
• ⌨️ Your fingers already know it. ⌘Z / ⇧⌘Z undo and redo, ⌘S saves, ⌘P exports a PDF, ⌘F finds — nothing to relearn.

Install in one line

dsh plugin --profile web add dsh-marktext

Using the Desktop app? Open Plugins → Add plugin → Install a third-party plugin, enter dsh-marktext, click Enable now, then restart the app once. (The desktop profile is managed by the app, so the CLI line above is for dsh web only.)

{
  "dsh": { "profile": { "bundles": [..., "dsh-marktext"] } },
  "dependencies": { ..., "dsh-marktext": "^0.1.13" }
}

cd ~/.dsh/profiles/desktop && pnpm install

What you get

Under the hood

DSH Web (React)
  lib/client.js  ── sidebar tab kind `marktext` (patterns: *.md)
      │             tab body = <iframe src="/dsh-marktext/renderer/<token>/index.html">
      │ postMessage (single envelope: __dshmkt)
      ▼
renderer/ (standalone Vite build, contains muya + mermaid)
      │ fetch
      ▼
lib/index.js (host plugin)
  · /dsh-marktext/renderer/<token>/*   static assets; misses fall back to the document folder
  · /dsh-marktext/api/open|save|stat   through ctx.fs; save requires baseVersion

The editor runs in an iframe on purpose: muya declares its CSS variables on :root and appends floating toolbars to document.body, so inlining it would leak styles into the host. The iframe isolates all of that; only document, theme and save calls cross the boundary.

Troubleshooting

If a .md opens but the tab says something like "no viewer available", the client half didn't register its tab body. Read the registration report:

curl -s http://127.0.0.1:<DSH-port>/dsh-marktext/api/diag | python3 -m json.tool

typeRegistered, bodyRegistered, conversation and errors point at the failing step — "conversation": false means Quote will fall back to the clipboard.

FAQ

Is this the MarkText app? No. It's MarkText's editor core (muya) wrapped for DSH — no Electron, no desktop shell, no second app to install.

Where does a quote go? Into the composer draft of the tab's own session, not the one in front of you — open a file from session A while working in session B and the quote still lands in A, the session that file belongs to.

Is the PDF a real file? Yes — click PDF and notes/plan.pdf appears next to notes/plan.md (a -1, -2 suffix avoids overwriting), and the tab that opens shows the result. It is generated in the page (html2canvas + jsPDF, both lazy-loaded only when you export) and laid out on A4 with half-inch margins. Text is rasterised, so the PDF is not selectable — that is the price of doing this without a 500 kB layout engine, and it keeps the plugin offline and dependency-free at runtime.

Why does it save instead of downloading? The editor runs inside an Electron dsh-app:// shell that treats a blob: download as "open this in a tab". Writing through the host's fs avoids that entirely and puts the PDF where the document already lives.

Will it reformat my file? It saves what the editor serializes, which is standard CommonMark/GFM. The version guard is what protects you: if the file changed underneath, you get a conflict, not a silent rewrite.

Does it work offline? Yes — every asset, font, diagram engine and syntax highlighter ships with the plugin.

Does it fight with other Markdown plugins? Both it and dsh-markdown-typora claim *.md in the extension band, so install one of them, not both.

Known limits: absolute image paths (/abs/a.png, file://) aren't resolved yet; quoting needs a session-scoped file (an absolute-path tab falls back to the clipboard); the exported PDF is raster, so its text can't be selected or searched. Package size ≈4 MB tarball; first paint ≈1.6 MB, plus ≈240 kB only when you export a PDF.

Development

npm install
npm run build:renderer            # writes renderer/ (committed; only needed when src/renderer changes)
npm test                          # host routes, version guard, traversal, origin fence, client registration, quote formatting
node scripts/verify-renderer.mjs  # headless Chrome: open → render → save → disk
node scripts/verify-pdf.mjs       # headless Chrome: render → export PDF → assert the bytes
node scripts/screenshot.mjs       # regenerates docs/assets/screenshot-*.png

Release

Publishing uses npm Trusted Publishing (OIDC) — no token or secret in the repo. Every push to main runs tests, verifies the committed renderer/ matches src/renderer/, publishes only when the version is new, and creates a GitHub Release (v<version>, generated notes).

npm version patch --no-git-tag-version
git commit -am "chore: release x.y.z"
git push

Star history

License

MIT — see LICENSE. Third-party components and MarkText attribution: NOTICE.md.