SuperAPI AI 工具集

preview-plan

通用与其它

查看项目

更新于 10-16 06:15

技能介绍

用途:将实现计划(Markdown)渲染为带侧边栏目录和阅读进度的可导航 HTML,便于评审者快速定位章节、在段落间跳转并专注重点内容。资料指出,无需等用户要求预览,写计划时可直接推送内容生成预览。

主要能力:侧边栏目录(按标题层级嵌套缩进)、阅读进度、任务列表完成数统计。对计划 Markdown 的写法有建议:用 # 标题作为计划名(显示在侧边栏头部),## 作为主要阶段或章节(每个成为目录项),### 与 #### 作为嵌套目录项;用任务列表(- [ ] / - [x])让侧边栏统计已完成与总数;用表格做对比、风险矩阵、字段说明;用 diff 代码块对带 + / - 的行着色;用 mermaid 代码块渲染交互式图表;用引用块(>)标注提示与重要说明。

使用方式:支持预览已有文件,如 ./run.sh plan.plan.md;也支持直接管道传入生成的内容(资料称此为首选),例如 cat <<'EOF' | ./run.sh 后接计划内容。脚本会自动在浏览器中打开结果,资料明确说明不要手动打开文件。技能调用形式包括 /preview-plan implementation.plan.md 和 cat design.plan.md | /preview-plan。

选项:-o, --output PATH 指定自定义输出路径;--no-browser 跳过打开浏览器,仅输出文件路径。

文件要求:扩展名为 .plan.md 或 .plan,编码为 UTF-8。

限制:资料仅说明上述渲染与打开行为,未提供收费、平台支持范围、性能或错误处理等信息,暂未提供。