Skills

Docs Canvas

Render a documentation-style Cursor Canvas that organizes architecture notes, API...

Install

npx skills add cursor/plugins --skill docs-canvas -g -a claude-code -y
Repository
cursor/plugins15k
Category
Writing
Updated
4d ago
License
See repository
Context cost
Lightabout 667 tokens
Runs scripts
No, instructions only

What it does

Render a documentation-style Cursor Canvas that organizes architecture notes, API references, walkthroughs, and how-tos into a navigable layout with sections, tables of contents, and cross-references. Use 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.

Docs Canvas

Build a canvas that presents documentation, architecture notes, API references, design docs, runbooks, or codebase walkthroughs, as an interactive, navigable surface rather than as a flat markdown file.

Status: placeholder. The skill structure is in place so the canvas welcome page can surface this plugin via the marketplace query, but the full skill body still needs to be written. Treat the steps below as a starting outline and refine as the docs canvas pattern matures.

Prerequisites

Read ~/.cursor/skills-cursor/canvas/SKILL.md first. It contains the generation policy, design guidance, slop rules, self-check, and file-path conventions you must follow. The full component and hook surface is declared in ~/.cursor/skills-cursor/canvas/sdk/index.d.ts and its sibling .d.ts files, read them to discover exact exports and prop shapes rather than guessing.

Gather the source material

Accept any of: a directory of markdown files, a single doc URL, an inline outline, or a question to answer from the codebase. Collect headings, code blocks, diagrams, and any cross-references between documents.

Plan the canvas layout

Decide the top-level structure before writing any components. A docs canvas usually has:

  1. Overview, A short summary card with the purpose of the doc, scope, and audience.
  2. Table of contents, Navigable list of sections, ideally pinned or sticky so the reader can jump around.
  3. Body sections, One section per logical unit (architecture, API, examples, gotchas). Each section can mix prose, code blocks, diagrams, and callouts.
  4. References, Links to related docs, source files, RFCs, and external material.

Render with canvas primitives

Prefer built-in canvas components over raw HTML:

Read the whole SKILL.md on GitHub

More in Writing