SuperAPI AI 工具集

cursor-docs-canvas

写作与研究

查看项目

更新于 10-16 06:07

技能介绍

用途

cursor-docs-canvas 用于构建一个“文档画布”(Docs Canvas),把文档类内容——架构说明、API 参考、设计文档、运行手册(runbook)或代码库走查——呈现为可交互、可导航的界面,而不是一份扁平的 Markdown 文件。

主要能力

  • 组织文档结构:规划概览、目录、正文分区与参考链接等顶层结构。
  • 支持多种来源素材:可接受 Markdown 文件目录、单个文档 URL、内联大纲,或需要从代码库回答的问题。
  • 使用 Canvas 原语渲染:建议优先使用内置 Canvas 组件而非原始 HTML,包括卡片/分区、带语法高亮的代码块、图表(DAG 布局、mermaid)、提示框(Important、Warning、Note、Deprecated)以及用于 API 参数列表和选项矩阵的表格。
  • 提供 Codex 适配方案:当 Canvas 不可用时,使用 scripts/cursor_canvas_adapters.py 中的 render_docs_canvas 生成显式、有界的项目本地 Markdown/HTML 产物;该产物包含目录、章节锚点和回源文件链接。

使用方式

  1. 先阅读 ~/.cursor/skills-cursor/canvas/SKILL.md,其中包含生成策略、设计指导、slop 规则、自检和文件路径约定。
  2. 阅读 ~/.cursor/skills-cursor/canvas/sdk/index.d.ts 及其同级 .d.ts 文件,以发现确切的导出和 prop 形状,而不是猜测。
  3. 收集源素材:目录、URL、内联大纲或代码库问题,并收集标题、代码块、图表和文档间的交叉引用。
  4. 在编写组件前规划画布布局,通常包括:概览(目的、范围、受众的简短摘要卡片)、目录(可导航的章节列表,最好固定或粘性)、正文分区(每个逻辑单元一节,可混合散文、代码块、图表和提示框)、参考(相关文档、源文件、RFC 和外部材料的链接)。
  5. 使用 Canvas 原语渲染,并撰写面向读者的散文:先给出答案或标题,再解释;示例保持小而可运行;用代码引用标注源文件,方便读者跳转。

适用场景

  • 需要把架构笔记、API 参考、设计文档、运行手册或代码库走查整理成可导航文档时。
  • 希望读者能快速跳转章节、查看图表和代码示例,而不是阅读长 Markdown 文件时。
  • 在 Canvas 不可用的环境中,需要生成项目本地 Markdown/HTML 文档产物时。

限制

  • 该技能目前为占位状态(placeholder):技能结构已就位,以便画布欢迎页可通过市场查询展示该插件,但完整技能正文仍需编写;文档中的步骤应视为起始大纲。
  • canvas_parity 保持 UNAVAILABLE。
  • 不会创建任何产品配置。
  • 外部依赖保持显式:Cursor Canvas 界面和 SDK 声明。
  • 不得读取 ~/.cursor/skills-cursor。
  • 关于收费、价格、平台支持范围等信息,资料中暂未提供。