Cursor Docs Canvas 插件把文档渲染成可导航 Canvas 的完整指南【免费下载链接】pluginsCursor plugin specification and official plugins项目地址: https://gitcode.com/GitHub_Trending/plugins125/pluginsDocs Canvas 是 Cursor 官方插件仓库中的一个 Developer Tools 类插件其目标是将架构笔记、API 参考、运行手册runbook和代码库解读等文档从从上到下平铺阅读的 markdown 文件转变为可扫描、可跳转的 Cursor Canvas 页面。本文以 docs-canvas/README.md 为核心结合插件清单与技能定义完整拆解该插件的定位、目录结构、技能触发方式、四段式文档布局规范以及 Canvas 原语的使用策略帮助读者理解docs on a canvas这一文档呈现模式的实现骨架。一、插件定位可导航的文档表面而非平铺 Markdowndocs-canvas/README.md 对插件的定义非常明确它渲染的是documentation——架构笔记、API 参考、设计文档、runbook、代码库 walkthrough——呈现为一个 interactive、navigable 的表面而不是一份 flat markdown file。这与传统生成一篇长文档的做法有本质区别扫描优先于阅读读者不必从头读到尾可以先看 Overview 卡片定位主题再通过目录跳转感兴趣的章节混合表现力每个逻辑单元架构、API、示例、陷阱都可以混排 prose、代码块、图表、callout而不受单一文档流限制交叉引用References 区块把相关文档、源码文件、RFC 和外部资料聚合为可点击的引用入口。二、当前状态有意的初始脚手架Scaffold写作本文时必须首先说明一个事实该插件在仓库中自我声明为initial scaffold。docs-canvas/README.md 的 Status 一节写明技能结构已经完整Canvas 欢迎页会在 marketplace 中把它展示出来但技能正文是刻意保留的起始大纲intentionally a starting outline而非完全调优后的 playbook预期会随着 docs on a canvas 模式的成熟而持续迭代。skills 定义文件 顶部也以 blockquote 形式重复了同样的状态说明placeholder... full skill body still needs to be writtenCHANGELOG.md 则确认了版本历史只有 0.1.0 一次初始发布0.1.0 — initial releaseAdded thedocs-canvasskill: initial scaffold for rendering documentation (architecture notes, API references, runbooks, codebase walkthroughs) as a navigable Cursor Canvas with overview, table of contents, body sections, and references.因此使用本插件时应把其步骤视为起点大纲在实际使用中结合自己的文档场景做精化。这一自我声明对评估插件成熟度很重要下文所有流程描述均基于当前 0.1.0 的脚手架内容。三、插件目录结构与清单解析按照仓库根 README.md 中描述的 multi-plugin marketplace 布局每个插件是仓库根目录下的独立目录拥有自己的.cursor-plugin/plugin.json清单Docs Canvas 插件的实际结构如下路径作用docs-canvas/.cursor-plugin/plugin.json插件清单name、version、author、keywords、category、skills 路径docs-canvas/skills/docs-canvas/SKILL.md核心技能定义含 frontmatter 触发描述与完整工作流程docs-canvas/assets/avatar.png插件头像256x256docs-canvas/README.md / CHANGELOG.md / LICENSE说明、变更记录0.1.0、MIT 协议清单文件 plugin.json 的关键字段{ name: docs-canvas, displayName: Docs Canvas, version: 0.1.0, description: Render documentation as a navigable canvas., author: { name: Cursor, email: pluginscursor.com }, license: MIT, logo: assets/avatar.png, keywords: [cursor-plugin, canvas, documentation, docs, architecture, reference], category: developer-tools, tags: [canvas, documentation, workflow], skills: ./skills/ }几个值得注意的点skills字段指向./skills/声明了插件携带的技能目录与仓库根 README 中skills/ Agent skills (SKILL.md with frontmatter)的约定一致name采用 kebab-case 小写标识符符合 schemas/plugin.schema.json 中^[a-z0-9](https://link.gitcode.com/i/d350cd65fc288e8c0bc5e4f787450628)?$的模式约束该插件不包含 rules、mcp.json、agents 等组件——它是一个纯技能型skill-only插件所有行为逻辑都编码在 SKILL.md 的流程指令中。四、技能触发frontmatter 与触发短语技能的何时被调用由 SKILL.md 的 YAML frontmatterdescription决定其中明确列出使用场景when the user asks for a docs canvas, documentation overview, architecture walkthrough, API reference page, or wants to render structured documentation as an interactive canvas。README.md 的 When to use 一节则给出了三类具体触发场景把架构笔记、设计文档或 RFC 渲染成可扫描而非只能顺序阅读的形态把一个 markdown 文档目录或单份大型文档转换为带跳转导航的 Canvas用一个比单条回复更丰富的布局sections、diagrams、tables、callouts来回答一个代码库问题。README 同时列出了推荐的触发短语trigger phrasesdocs canvas、documentation overview、architecture walkthrough、API reference page或render this doc as an interactive canvas。这组短语与 frontmatter 描述基本一一对应说明作者有意让 marketplace 的关键词检索和自然语言触发都能命中同一技能。五、核心工作流四步从素材到 Canvas以下流程完整继承自 SKILL.md并逐节展开。5.1 前置条件先读 Canvas 技能与 SDK 声明SKILL.md 的第一步不是写文档而是要求 Agent 先阅读两处本地声明~/.cursor/skills-cursor/canvas/SKILL.md—— 包含生成策略generation policy、设计指引、slop rules、自检清单和文件路径约定~/.cursor/skills-cursor/canvas/sdk/index.d.ts及其同目录的其他.d.ts文件 —— 完整的 canvas 组件与 hook 表面声明。原文的要求很直接去读这些声明来discover exact exports and prop shapes rather than guessing发现确切的导出与 prop 形状而不是猜测。这意味着 Docs Canvas 插件刻意把自己降级为内容层技能渲染能力全部委托给 Cursor 内置的 canvas 技能栈——插件本身不携带任何可执行代码这一设计保持了技能包的最小化。5.2 收集素材Gather the source material技能接受四类输入之一一个 markdown 文件目录单个文档 URL一份内联大纲inline outline一个需要从代码库中回答的问题。收集时要提取的元素包括标题headings、代码块、图表以及文档之间的交叉引用。README.md 的 Requirements 一节与这里互为印证源素材可以是 markdown 目录、单个 doc URL、inline outline或一个 codebase question——两种表述完全对应说明 README 与 SKILL 是同一规范的两个视角。5.3 规划布局四段式文档骨架这是本插件最核心的设计规范README.md 的 How its organized 与 SKILL.md 的 Plan the canvas layout 描述同一结构Overview概览卡——一个简短的 summary card写清文档的 purpose目的、scope范围、audience受众Table of contents目录——可导航的章节列表理想状态下 pinned 或 sticky让读者随时跳转Body sections正文节——每个逻辑单元一节架构、API、示例、陷阱每节内部可自由混排 prose、代码块、图表、calloutReferences引用区——指向相关文档、源码文件、RFC、外部资料的链接。SKILL.md 强调Decide the top-level structure before writing any components在写任何组件之前先决定顶层结构即布局规划必须先于渲染。README 对这四段又补了一句关键定性Those are a floor, not a ceiling——四段式结构是下限而非上限技能鼓励针对具体主题选用真正有帮助的表现形式diagrams、tables、decision trees、worked examples 等。5.4 用 Canvas 原语渲染SKILL.md 明确要求Prefer built-in canvas components over raw HTML并给出原语到内容类型的映射策略Canvas 原语适用内容cards / sections视觉分组把相关内容组织在一起code blocks带语法高亮代码片段diagramsDAG layout、mermaid架构calloutsImportant / Warning / Note / Deprecated需要注意或警告的信息tablesAPI 参数列表、选项矩阵5.5 文风与引用Tone and content面向读者的行文reader-facing prose先给答案或标题再展开解释示例保持small and runnable小而可运行引用源码时使用code references让读者可以一键跳转——这与四段式中 References 区块的设计形成呼应文档页本身成为代码库的导航入口。5.6 创意原则下限不是上限SKILL.md 最后一节 Be creative 把设计目标定义为the fastest possible path for the reader to understand the topic读者理解主题的尽可能快的路径。它列举了可选的表现形式diagram、sequence chart、side-by-side comparison、decision tree、glossary、curated FAQ、单个大型 worked example——whatever fits什么合适用什么。这解释了为何 README 反复强调四段结构只是 floor插件的规范层约束的是必备结构而把表现力完全交给执行时面对的具体素材。六、使用前提与同类插件对照环境要求来自 README.md Requirements 一节Cursor 已启用 Canvas 能力Cursor with Canvas enabled至少提供一种源素材markdown 目录、单个文档 URL、内联大纲或一个待回答的代码库问题。仓库内对照仓库中的 pr-review-canvas 插件采用几乎相同的技能骨架同样的 canvas 前置声明、同样的 Be creative / floor, not a ceiling 结尾但面向 PR diff 评审场景Docs Canvas 则是同一 render X as a navigable canvas 模式在文档场景下的实例化。两者的对照可以印证在仓库中Canvas 作为一等呈现层 是一类被复用的插件设计模式而 Docs Canvas 是其中专注于文档呈现的成员。七、小结与适用边界Docs Canvas 插件当前 0.1.0提供的是一条清晰的文档转 Canvas 流水线收集素材 → 规划四段式布局 → 用 canvas 原语渲染 → 引用源码其约束条件有二依赖 Cursor 的 Canvas 能力与内置 canvas 技能栈生成策略、SDK 类型声明插件本身零代码技能正文是有意保留的起始大纲README 与 CHANGELOG 均已明确声明其为 scaffold实际使用中预期随 docs on a canvas 模式成熟而迭代。适合读者关注的后续演进点技能正文从起始大纲到调优 playbook的补全以及 marketplace 中触发短语与关键词覆盖面的扩展。所有行为事实均可回溯至 docs-canvas/README.md、docs-canvas/skills/docs-canvas/SKILL.md 与 docs-canvas/.cursor-plugin/plugin.json 三个文件。【免费下载链接】pluginsCursor plugin specification and official plugins项目地址: https://gitcode.com/GitHub_Trending/plugins125/plugins创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Cursor Docs Canvas 插件：把文档渲染成可导航 Canvas 的完整指南
Cursor Docs Canvas 插件把文档渲染成可导航 Canvas 的完整指南【免费下载链接】pluginsCursor plugin specification and official plugins项目地址: https://gitcode.com/GitHub_Trending/plugins125/pluginsDocs Canvas 是 Cursor 官方插件仓库中的一个 Developer Tools 类插件其目标是将架构笔记、API 参考、运行手册runbook和代码库解读等文档从从上到下平铺阅读的 markdown 文件转变为可扫描、可跳转的 Cursor Canvas 页面。本文以 docs-canvas/README.md 为核心结合插件清单与技能定义完整拆解该插件的定位、目录结构、技能触发方式、四段式文档布局规范以及 Canvas 原语的使用策略帮助读者理解docs on a canvas这一文档呈现模式的实现骨架。一、插件定位可导航的文档表面而非平铺 Markdowndocs-canvas/README.md 对插件的定义非常明确它渲染的是documentation——架构笔记、API 参考、设计文档、runbook、代码库 walkthrough——呈现为一个 interactive、navigable 的表面而不是一份 flat markdown file。这与传统生成一篇长文档的做法有本质区别扫描优先于阅读读者不必从头读到尾可以先看 Overview 卡片定位主题再通过目录跳转感兴趣的章节混合表现力每个逻辑单元架构、API、示例、陷阱都可以混排 prose、代码块、图表、callout而不受单一文档流限制交叉引用References 区块把相关文档、源码文件、RFC 和外部资料聚合为可点击的引用入口。二、当前状态有意的初始脚手架Scaffold写作本文时必须首先说明一个事实该插件在仓库中自我声明为initial scaffold。docs-canvas/README.md 的 Status 一节写明技能结构已经完整Canvas 欢迎页会在 marketplace 中把它展示出来但技能正文是刻意保留的起始大纲intentionally a starting outline而非完全调优后的 playbook预期会随着 docs on a canvas 模式的成熟而持续迭代。skills 定义文件 顶部也以 blockquote 形式重复了同样的状态说明placeholder... full skill body still needs to be writtenCHANGELOG.md 则确认了版本历史只有 0.1.0 一次初始发布0.1.0 — initial releaseAdded thedocs-canvasskill: initial scaffold for rendering documentation (architecture notes, API references, runbooks, codebase walkthroughs) as a navigable Cursor Canvas with overview, table of contents, body sections, and references.因此使用本插件时应把其步骤视为起点大纲在实际使用中结合自己的文档场景做精化。这一自我声明对评估插件成熟度很重要下文所有流程描述均基于当前 0.1.0 的脚手架内容。三、插件目录结构与清单解析按照仓库根 README.md 中描述的 multi-plugin marketplace 布局每个插件是仓库根目录下的独立目录拥有自己的.cursor-plugin/plugin.json清单Docs Canvas 插件的实际结构如下路径作用docs-canvas/.cursor-plugin/plugin.json插件清单name、version、author、keywords、category、skills 路径docs-canvas/skills/docs-canvas/SKILL.md核心技能定义含 frontmatter 触发描述与完整工作流程docs-canvas/assets/avatar.png插件头像256x256docs-canvas/README.md / CHANGELOG.md / LICENSE说明、变更记录0.1.0、MIT 协议清单文件 plugin.json 的关键字段{ name: docs-canvas, displayName: Docs Canvas, version: 0.1.0, description: Render documentation as a navigable canvas., author: { name: Cursor, email: pluginscursor.com }, license: MIT, logo: assets/avatar.png, keywords: [cursor-plugin, canvas, documentation, docs, architecture, reference], category: developer-tools, tags: [canvas, documentation, workflow], skills: ./skills/ }几个值得注意的点skills字段指向./skills/声明了插件携带的技能目录与仓库根 README 中skills/ Agent skills (SKILL.md with frontmatter)的约定一致name采用 kebab-case 小写标识符符合 schemas/plugin.schema.json 中^[a-z0-9](https://link.gitcode.com/i/d350cd65fc288e8c0bc5e4f787450628)?$的模式约束该插件不包含 rules、mcp.json、agents 等组件——它是一个纯技能型skill-only插件所有行为逻辑都编码在 SKILL.md 的流程指令中。四、技能触发frontmatter 与触发短语技能的何时被调用由 SKILL.md 的 YAML frontmatterdescription决定其中明确列出使用场景when the user asks for a docs canvas, documentation overview, architecture walkthrough, API reference page, or wants to render structured documentation as an interactive canvas。README.md 的 When to use 一节则给出了三类具体触发场景把架构笔记、设计文档或 RFC 渲染成可扫描而非只能顺序阅读的形态把一个 markdown 文档目录或单份大型文档转换为带跳转导航的 Canvas用一个比单条回复更丰富的布局sections、diagrams、tables、callouts来回答一个代码库问题。README 同时列出了推荐的触发短语trigger phrasesdocs canvas、documentation overview、architecture walkthrough、API reference page或render this doc as an interactive canvas。这组短语与 frontmatter 描述基本一一对应说明作者有意让 marketplace 的关键词检索和自然语言触发都能命中同一技能。五、核心工作流四步从素材到 Canvas以下流程完整继承自 SKILL.md并逐节展开。5.1 前置条件先读 Canvas 技能与 SDK 声明SKILL.md 的第一步不是写文档而是要求 Agent 先阅读两处本地声明~/.cursor/skills-cursor/canvas/SKILL.md—— 包含生成策略generation policy、设计指引、slop rules、自检清单和文件路径约定~/.cursor/skills-cursor/canvas/sdk/index.d.ts及其同目录的其他.d.ts文件 —— 完整的 canvas 组件与 hook 表面声明。原文的要求很直接去读这些声明来discover exact exports and prop shapes rather than guessing发现确切的导出与 prop 形状而不是猜测。这意味着 Docs Canvas 插件刻意把自己降级为内容层技能渲染能力全部委托给 Cursor 内置的 canvas 技能栈——插件本身不携带任何可执行代码这一设计保持了技能包的最小化。5.2 收集素材Gather the source material技能接受四类输入之一一个 markdown 文件目录单个文档 URL一份内联大纲inline outline一个需要从代码库中回答的问题。收集时要提取的元素包括标题headings、代码块、图表以及文档之间的交叉引用。README.md 的 Requirements 一节与这里互为印证源素材可以是 markdown 目录、单个 doc URL、inline outline或一个 codebase question——两种表述完全对应说明 README 与 SKILL 是同一规范的两个视角。5.3 规划布局四段式文档骨架这是本插件最核心的设计规范README.md 的 How its organized 与 SKILL.md 的 Plan the canvas layout 描述同一结构Overview概览卡——一个简短的 summary card写清文档的 purpose目的、scope范围、audience受众Table of contents目录——可导航的章节列表理想状态下 pinned 或 sticky让读者随时跳转Body sections正文节——每个逻辑单元一节架构、API、示例、陷阱每节内部可自由混排 prose、代码块、图表、calloutReferences引用区——指向相关文档、源码文件、RFC、外部资料的链接。SKILL.md 强调Decide the top-level structure before writing any components在写任何组件之前先决定顶层结构即布局规划必须先于渲染。README 对这四段又补了一句关键定性Those are a floor, not a ceiling——四段式结构是下限而非上限技能鼓励针对具体主题选用真正有帮助的表现形式diagrams、tables、decision trees、worked examples 等。5.4 用 Canvas 原语渲染SKILL.md 明确要求Prefer built-in canvas components over raw HTML并给出原语到内容类型的映射策略Canvas 原语适用内容cards / sections视觉分组把相关内容组织在一起code blocks带语法高亮代码片段diagramsDAG layout、mermaid架构calloutsImportant / Warning / Note / Deprecated需要注意或警告的信息tablesAPI 参数列表、选项矩阵5.5 文风与引用Tone and content面向读者的行文reader-facing prose先给答案或标题再展开解释示例保持small and runnable小而可运行引用源码时使用code references让读者可以一键跳转——这与四段式中 References 区块的设计形成呼应文档页本身成为代码库的导航入口。5.6 创意原则下限不是上限SKILL.md 最后一节 Be creative 把设计目标定义为the fastest possible path for the reader to understand the topic读者理解主题的尽可能快的路径。它列举了可选的表现形式diagram、sequence chart、side-by-side comparison、decision tree、glossary、curated FAQ、单个大型 worked example——whatever fits什么合适用什么。这解释了为何 README 反复强调四段结构只是 floor插件的规范层约束的是必备结构而把表现力完全交给执行时面对的具体素材。六、使用前提与同类插件对照环境要求来自 README.md Requirements 一节Cursor 已启用 Canvas 能力Cursor with Canvas enabled至少提供一种源素材markdown 目录、单个文档 URL、内联大纲或一个待回答的代码库问题。仓库内对照仓库中的 pr-review-canvas 插件采用几乎相同的技能骨架同样的 canvas 前置声明、同样的 Be creative / floor, not a ceiling 结尾但面向 PR diff 评审场景Docs Canvas 则是同一 render X as a navigable canvas 模式在文档场景下的实例化。两者的对照可以印证在仓库中Canvas 作为一等呈现层 是一类被复用的插件设计模式而 Docs Canvas 是其中专注于文档呈现的成员。七、小结与适用边界Docs Canvas 插件当前 0.1.0提供的是一条清晰的文档转 Canvas 流水线收集素材 → 规划四段式布局 → 用 canvas 原语渲染 → 引用源码其约束条件有二依赖 Cursor 的 Canvas 能力与内置 canvas 技能栈生成策略、SDK 类型声明插件本身零代码技能正文是有意保留的起始大纲README 与 CHANGELOG 均已明确声明其为 scaffold实际使用中预期随 docs on a canvas 模式成熟而迭代。适合读者关注的后续演进点技能正文从起始大纲到调优 playbook的补全以及 marketplace 中触发短语与关键词覆盖面的扩展。所有行为事实均可回溯至 docs-canvas/README.md、docs-canvas/skills/docs-canvas/SKILL.md 与 docs-canvas/.cursor-plugin/plugin.json 三个文件。【免费下载链接】pluginsCursor plugin specification and official plugins项目地址: https://gitcode.com/GitHub_Trending/plugins125/plugins创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考