返回目录
界面增强 插件

dock-markdown

AKS1st/dock-markdown

DSH 生态中最好的 Markdown 查看插件:GFM 渲染、DOMPurify 消毒、文档大纲、相对路径图片/链接解析、一键切换编辑;依赖 dock/dock-files/dock-editor | The best Markdown viewer for DSH: GFM rendering, DOMPurify sanitization, document outline, relative image/link resolution, one-click switch to editing; requires dock/dock-files/dock-editor

Stars
0
Forks
0
Issues
0
更新
今天

PROJECT TOPICS

项目标签

INSTALL REFERENCE

安装参考

未验证
dsh plugin --profile web add github:AKS1st/dock-markdown

该命令指向仓库当前默认分支;尚无绑定当前 commit 的完整验证结果。

PROJECT README

README

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

安装

需要 dockdock-filesdock-editor(查看器切换依赖其 editor 视图):

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

安全

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

相对路径资源只在会话工作区内解析:任何逃逸工作区的候选(..、符号链接指向工作区外、git 仓库根位于工作区之上等)一律跳过,不会读取工作区之外的文件。

License

MIT

CLASSIFICATION EVIDENCE

分类依据

项目类型插件
功能分类界面增强
规则置信度

系统优先读取 GitHub Topics,再与站内分类词典和词根规则比对。当前命中: markdown、web-ui。