preview-md

Installation
SKILL.md

MD 文件浏览器预览

写完方案/计划等需要 review 的 MD 文件后,用浏览器打开 GitHub 风格预览。


触发条件

当你(Claude)完成以下类型的 MD 文件创建或大幅修改时,必须触发此 skill

  1. 方案设计文档(docs/specs/**/*.md
  2. 开发计划文档(docs/plans/**/*.md
  3. 用户明确要求预览的任何 MD 文件

不可跳过原则:满足上述触发条件时,必须执行 Step 1 询问用户是否预览。Claude 不得以任何理由(如"纯后端文档"、"内容简单"、"不涉及 UI"等)自行判断跳过。是否预览由用户决定,不由 Claude 决定。

不触发 的场景:

  • .md 文件:HTML、JSON、YAML 等其他格式文件不走此 skill(HTML 原型直接用 open 命令打开)
  • memory 文件、CLAUDE.md、README.md 等非 review 类文件
  • 对 MD 文件的小幅修改(如修错别字、更新状态标记)

执行流程

Step 1: 询问用户

MD 文件写完后,向用户提问:

文件已创建:<文件路径>
要在浏览器中打开预览吗?

Step 2: 用户确认后打开预览

用户确认后,执行:

node ~/.claude/skills/preview-md/scripts/preview-md.mjs <md-file-absolute-path>

Step 3: 等待反馈

预览打开后,等待用户 review 反馈,根据反馈修改文档内容。


注意事项

  • 脚本位置在 ~/.claude/skills/preview-md/scripts/preview-md.mjs
  • 脚本会生成临时 HTML 文件并用默认浏览器打开
  • 渲染特性:GitHub Markdown CSS + 左侧固定目录(h1-h4)+ 滚动高亮 + 平滑跳转

Related skills
Installs
3
GitHub Stars
102
First Seen
Apr 3, 2026