用途:docs-canvas 用于把文档类内容(架构说明、API 参考、设计文档、运行手册、代码库导览)呈现为可交互、可导航的画布,而不是扁平的 Markdown 文件。
状态:占位(placeholder)。技能结构已就位,使画布欢迎页能通过市场查询展示该插件,但完整技能正文仍待编写;资料中的步骤应视为起始大纲。
前置条件:先阅读 ~/.cursor/skills-cursor/canvas/SKILL.md,其中包含生成策略、设计指引、slop 规则、自检和文件路径约定。完整组件与 hook 接口声明在 ~/.cursor/skills-cursor/canvas/sdk/index.d.ts 及其同级 .d.ts 文件中,应阅读以确认确切导出与 prop 形状,而非猜测。
使用方式:收集源材料,可接受 Markdown 文件目录、单个文档 URL、内联大纲,或需要从代码库回答的问题;收集标题、代码块、图表及文档间交叉引用。随后规划画布布局,通常包含:概览(目的、范围、受众的摘要卡片)、目录(可导航章节列表,最好固定或粘性)、正文各节(每个逻辑单元一节,如架构、API、示例、注意事项,可混合散文、代码块、图表与提示框)、参考(相关文档、源文件、RFC 及外部材料链接)。渲染时优先使用内置画布组件而非原始 HTML:用卡片/区块分组内容,用带语法高亮的代码块展示片段,用图表(DAG 布局、mermaid)表达架构,用提示框标注 Important、Warning、Note、Deprecated,用表格呈现 API 参数列表与选项矩阵。
内容与语气:面向读者写作,先给答案或要点再解释;示例保持小而可运行;用代码引用标注源文件以便读者跳转。
限制:当前为占位状态,完整技能正文尚未提供;具体功能、收费、价格、平台与效果暂未提供。上述章节为下限而非上限,目标是让读者以最快路径理解主题。