DeepSHPlugins
dock-markdown 專案預覽
GITHUB / COMMUNITY PROJECT

dock-markdown

UI 增強JavaScriptMIT

dock 系列 Markdown 檢視器:GFM 渲染 + DOMPurify 消毒、文件大綱、相對路徑圖片/連結解析,可一鍵切換編輯。

3 StarsAKS1st 更新時間 2026-08-23
訪問 GitHub 倉庫
dock-markdown 專案預覽

專案介紹

中文

dock 系列 Markdown 檢視器:GFM 渲染 + DOMPurify 消毒、文件大綱、相對路徑圖片/連結解析,可一鍵切換編輯。

English

Markdown viewer for the dock workbench: GFM rendering with DOMPurify sanitization, document outline and relative-path image/link resolution, with one-click switch to editing.

專案資訊與收錄訊號

快照 2026-09-11
作者 / 組織
AKS1st
倉庫
AKS1st/dock-markdown
GitHub Stars
3
Forks
0
開發語言
JavaScript
許可證
MIT
最近推送
2026-08-23
Manifest
資料中檢測到宣告

公開倉庫不自動等於可商用;許可證與當前相容性以原專案文件為準。Manifest 和資料評分不構成安裝安全認證。

資料評分

59/ 100
維護活躍
88
文件與實用資訊
99
生態關注度
17
安裝便捷訊號
75
專案宣告訊號
100

近 19 天仍在更新;README 含完整安裝與使用說明;關注度尚低(3)。

評分來自已有資料快照的五維模型,僅作瀏覽參考,不是實際使用評測或安全檢測結論。

安裝與使用

所有專案資料與許可均以對應 GitHub 倉庫為準。

dsh plugin --profile web add dock-markdown

複製命令不會自動執行。請先閱讀倉庫文件,確認環境要求與許可證。

專案截圖

倉庫 README

GitHub 原文

已儲存的倉庫文件快照;文件抓取時間未記錄,可能與上方目錄介紹處於不同版本。安裝前請核對當前倉庫說明。

儲存庫檔案保留原文,指令與授權文字不作自動改寫。

dock-markdown

English

DSH 生态中最好的 Markdown 查看插件 —— 没有之一。 GFM 渲染、DOMPurify 消毒、文档大纲、相对路径图片/链接解析、一键切编辑,读 README、看文档、审稿子,dock-markdown 让 Markdown 在 DSH 里第一次有了「编辑器级」体验。

dock 系列的 Markdown 查看插件:为 dock-files 文件域注册 markdown 文件查看器(md / markdown / mdx)与对应的编辑器区视图。通过 dock-editor 的 /desk-editor/fs.read 读取文件内容,用 marked + DOMPurify 渲染为消毒后的 HTML,并提供一键切换到 dock-editor 编辑。

效果预览

dock-markdown Markdown 查看视图

功能

  • Markdown 渲染:marked(GFM)+ DOMPurify 消毒,输出纯静态 HTML。
  • 相对路径资源解析:Markdown 中的相对图片与内部跳转链接按「Markdown 所在目录 → 当前路径所在 git 仓库根目录 → 会话工作区根目录」的优先级解析;图片以内联 data URL 展示,内部链接点击后通过工作台打开目标文件,#锚点 链接平滑滚动到对应标题。
  • 文档大纲:工具栏 ☰ 按钮展开/收起大纲栏,按标题层级缩进列出 h1–h6,点击跳转到对应标题,滚动时高亮当前所在章节。
  • 查看器切换:工具栏按钮一键在「查看」与「编辑」(dock-editor)之间切换。
  • 主题适配:排版样式使用 DSH 主题 token,跟随亮/暗主题。
  • 代码块 / 表格 / 引用等常用 GFM 元素均有排版样式。

依赖

依赖类型说明
dock >= 0.1.0peer(必需)工作台外壳:编辑器区视图、浮窗、ctx.workbench 由它提供
dock-files >= 0.1.0peer(必需)文件域服务:dock-markdown 作为 markdown 查看器被分发打开
dock-editor >= 0.1.0peer(必需)提供 /desk-editor/fs.read 读取文件内容,以及「一键切编辑」的目标编辑器视图
DSH Web 环境运行时必需,客户端平台为 Web
cordis ^4.0.0-rc.7peer插件框架(DSH 自带)
react ^18.2.0peer(可选)客户端渲染需要;未提供时查看器 UI 不激活
marked / dompurify内置(构建打包)GFM 渲染与消毒,随插件打包,无需单独安装

安装

需要 dock、dock-files 与 dock-editor(查看器切换依赖其 editor 视图):

推荐从 npm registry 安装:

dsh plugin --profile web add dock-base
dsh plugin --profile web add dock-files
dsh plugin --profile web add dock-editor
dsh plugin --profile web add dock-markdown

或通过 GitHub 安装(备选):

dsh plugin --profile web add github:AKS1st/dock
dsh plugin --profile web add github:AKS1st/dock-files
dsh plugin --profile web add github:AKS1st/dock-editor
dsh plugin --profile web add github:AKS1st/dock-markdown

安全

marked 输出的原始 HTML 一律经 DOMPurify.sanitize()(默认白名单)消毒后才写入 DOM,dangerouslySetInnerHTML 只用于消毒后的结果。已知取舍:DOMPurify 默认允许 style 属性,恶意 Markdown 理论上可用 CSS 做外联跟踪——如需更严格可加 FORBID_ATTR: ['style']。

相对路径资源不受会话工作区限制:Markdown 文件可能位于主机的任何位置(对话上下文可提及工作区外的文件,如 ~/.dsh/skills/...),其相对图片 / 内部链接按「Markdown 所在目录 → git 仓库根目录 → 会话工作区根目录」优先级解析,只要候选是存在的文件即可读取。

License

MIT

使用前核對

安裝步驟、相容版本與授權範圍以原專案當前文件為準。Stars 和評分是快照中的導航訊號。

安裝與排錯 · 專案問題反饋

同類專案