用途:将 Markdown 文件或管道内容渲染为 GitHub 风格 HTML,并自动在浏览器中打开预览,适合查看 README、文档、CONTRIBUTING.md 或 PR 描述等。
主要能力:支持完整 GitHub Flavored Markdown(标题、粗斜体、删除线、列表、引用、分隔线、链接、图片、表格);代码块语法高亮覆盖 100 多种语言,带复制按钮和可选行号;自动生成可点击的分级目录与固定侧边栏;支持任务列表复选框、LaTeX 数学公式(KaTeX 行内 $、块级 $$)、Emoji、脚注与引用;页面响应式,兼容现代浏览器。
使用方式:Agent 应通过 Bash 调用本技能的 run.sh,不要手写 HTML。示例:./run.sh README.md;cat docs.md | ./run.sh。命令用法:/preview-markdown README.md;cat docs.md | /preview-markdown;echo "# Hello\n\nThis is markdown" | /preview-markdown;/preview-markdown article.md --background "#ffffff"。临时内容建议用管道而非临时文件。脚本会自动生成 HTML 并打开浏览器,不要手动再打开以免重复标签页。
选项:-o, --output PATH 指定输出路径;--no-browser 跳过浏览器,仅输出文件路径。
输出与限制:生成独立 HTML 至 .preview-skills/markdown/{filename}.html,可直接打开、分享或归档;文件仅接受 .md、.markdown,默认最大 10MB(可配置),需 UTF-8 编码;浏览器需启用 JavaScript,部分资源依赖 CDN(Marked.js、DOMPurify、Mermaid)。常见问题:渲染异常时检查文件格式与编码;代码高亮需在三个反引号后标注受支持语言;数学公式需 KaTeX CDN 可访问且使用正确 LaTeX 语法;图片需使用可访问的绝对或相对路径。修改可编辑 config.sh、templates/scripts/markdown-renderer.js 与 templates/styles/markdown.css,运行 run.sh 测试。