SuperAPI AI 工具集

report-in-markdown

写作与研究

查看项目

更新于 10-15 21:49

技能介绍

用途:为任务文件、状态报告和独立报告提供统一的 Markdown 写作规范,适用于需要引用源码、图表或数学公式的文档。

主要能力:

  1. 文件引用规则:源文件必须写成带行锚点的 Markdown 链接,而非反引号路径。单行如 file.py:42,行范围如 file.py:40-50,整文件如 file.py;路径相对 Markdown 文件所在目录解析,必要时用 ../。
  2. 数学公式:使用 KaTeX 语法,行内用 $...$,独立块用 $$...$$,数学模式内文字用 \text{...};含上下标、分数、求和、积分的表达式优先用 LaTeX 而非 Unicode。
  3. 三个易静默出错的模式:每个 $$ 块上下各留空行且块内不留空行;KaTeX 未定义的算子(如 \diag、\cov、\var、\corr、\Cov、\Var、\E、\plim、\argmin、\argmax、\sgn、\tr、\rank)需写成 \operatorname{...};行内 $…$ 必须保持在同一行,字面 $ 需转义为 $。
  4. 表格:小于约 15 行的结果内联为 Markdown 表格,较大或代码生成的表格改为链接输出文件;内联时对齐语法保持一致,表头包含单位。
  5. 原始 HTML:仅用于 Markdown 无法表达的布局,如流程图、并排卡片、样式化提示框;正文、列表、表格、代码和数学优先用纯 Markdown。仪表盘以 html: true 渲染并用 DOMPurify 净化,class 和 style 保留,脚本、iframe、事件处理器和 javascript: URL 会被剥离,交互内容无法保留。HTML 较重的内容以仪表盘优先,GitHub 会剥离 style。

使用方式:任务钩子会在任务根目录下被编辑的 .md 文件上自动运行同一检查并给出非阻塞反馈。独立 Markdown 或未运行钩子时,可用自检 CLI(仅报告不修改):uv run --script <skill-dir>/scripts/check_markdown.py path/to/file.md,其中 <skill-dir> 为存放 SKILL.md 的目录;仅依赖标准库,也可用 python3 <skill-dir>/scripts/check_markdown.py …。

参考文件:references/rich-content.md 用于图表处理(PDF→PNG、相对路径嵌入),输出含图表时加载;references/baseline-io.md 用于 frontmatter 规范、文件名约定和输出路径解析,适用于永久独立产物,任务文件或状态返回不需要。

限制:资料未提供收费、价格、平台支持范围等信息。