mcpField
M
mdpreview

mdpreview

github.com/tdimino文档处理4141 次安装1 周前更新
代码仓库

关于 mdpreview

mdpreview 是用于 Markdown 文件的实时预览与批注工具,支持多标签、批注回复和书签。批注可写入源文件旁的 JSON 文件,也可通过命令行添加。

主要功能

  1. 01文件保存后自动刷新
  2. 02多标签浏览与运行时管理
  3. 03选中文本添加边栏批注
  4. 04批注回复与状态管理
  5. 05侧边栏目录、标签和书签
  6. 06命令行添加批注

适用场景

  1. 01边写 Markdown 边查看渲染结果
  2. 02在文档段落旁记录审阅意见
  3. 03通过 JSON 文件保存和交换批注
  4. 04在多个文档间切换并整理书签

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/tdimino/claude-code-minoan --skill mdpreview

安装后在 Claude Code 中输入/mdpreview确认已加载。

附带文件README.md

详细介绍

mdpreview — Markdown 预览与批注

支持实时重新加载、多标签页的 Catppuccin Mocha/Latte Markdown 查看器,并提供 Google Docs 风格的页边批注。

规范仓库:github.com/tdimino/dabarat。克隆该仓库,或确保 md_preview_and_annotate 位于你的 PYTHONPATH 中。

快速开始

# Preview one or more files
python3 -m md_preview_and_annotate file.md [file2.md ...] --port 3031

# If not installed globally, run from the cloned repo:
python3 ~/Desktop/Programming/md-preview-and-annotate/md_preview_and_annotate/__main__.py file.md
向运行中的服务添加文件
python3 -m md_preview_and_annotate --add another.md --port 3031
从 CLI 添加批注(无需服务)
python3 -m md_preview_and_annotate --annotate file.md \
  --text "RPL §235-b" --author "Claude" --comment "Cite the specific subsection"

此操作会直接写入旁挂 JSON(file.md.annotations.json)。实时查看器会在下一次 500ms 轮询周期中加载该批注。

功能

功能详情
实时重新加载每 500ms 轮询一次,文件保存后自动刷新
多标签页打开多个 .md 文件、切换标签页,并可在运行时添加或关闭标签页
标签页复用服务运行期间启动新文件,会将其添加为一个标签页
批注右侧页边的评论气泡,带有作者徽标(人类/AI)
线程回复可直接回复任意批注
书签全局持久化至 ~/.claude/bookmarks/,并包含 INDEX.md
旁挂 JSON批注与源文件一起保存在 file.md.annotations.json 中
文件标签通过命令面板中的 # 前缀使用 7 种预定义标签或自定义标签
命令面板使用 Cmd+K / Ctrl+K 快速访问命令、标签页和最近打开的文件
Catppuccin完整的 Mocha(深色)/ Latte(浅色)主题,包含 26 个 CSS 变量
字体排印标题使用 Cormorant Garamond,正文使用 DM Sans,代码使用 Victor Mono
侧边栏目录可调整大小并带有滚动定位功能的目录
代码高亮使用 Catppuccin 语法主题的 highlight.js
Chrome --app在无边框 Chrome 窗口中打开,带来原生应用般的体验
跨文件链接本地 .md 链接会在新标签页中打开,而不是跳转离开

批注系统

如需交互式创建批注,请在查看器中选择文本——此时会出现一个浮动按钮,然后在右侧栏中填写评论表单。

如需通过程序创建批注(例如从 Claude Code 创建),请使用 --annotate CLI 标志。无需运行中的服务——该操作会直接写入旁挂 JSON。

  • 人类作者——蓝色姓名徽标
  • AI 作者——紫红色姓名徽标,带机器人图标
  • 操作——解决(切换删除线)或删除(垃圾桶图标),悬停时显示
  • 持久化——旁挂 JSON 文件;查看器刷新或轮询文件时自动加载
旁挂 JSON 架构
{
  "version": 1,
  "tags": ["draft", "research"],
  "annotations": [
    {
      "id": "a1b2c3",
      "anchor": { "text": "selected phrase", "heading": "", "offset": 0 },
      "author": { "name": "Claude", "type": "ai" },
      "created": "2026-02-12T15:30:00+00:00",
      "body": "Comment text here",
      "resolved": false,
      "replies": []
    }
  ]
}

API 端点

端点方法用途
/api/content?tab=<id>GET获取标签页的 Markdown 内容
/api/tabsGET列出已打开的标签页
/api/annotations?tab=<id>GET获取标签页的批注
/api/tags?tab=<id>GET获取标签页的标签
/api/addPOST打开一个新的文件标签页
/api/closePOST关闭一个标签页
/api/annotatePOST创建批注
/api/resolvePOST切换批注的已解决状态
/api/replyPOST添加线程回复
/api/delete-annotationPOST删除批注
/api/tagsPOST添加或移除标签

评论

支持 Markdown