json-canvas
Create and edit JSON Canvas files (.canvas) with nodes, edges, groups, and connections
Install / Use
npx skills add obsidianmd/obsidian-skills --skill json-canvasInstalls into whichever agent you are using.
SKILL.md
Installable skill definition
Quality Score
Category
DesignSupported Platforms
Tags
Our assessment of json-canvas
json-canvas scores 96/100 on our quality scale, 16th of 260 Design skills we index (top 7%).
Its SKILL.md is 8.5 KB long, well organised into 20 sections with 7 code examples: a thorough specification that gives an agent plenty to work with.
With 52,232 GitHub stars, it is one of the more widely adopted skills in the catalogue.
Maintenance, license and trust
- The repository was last updated 5 days ago, so json-canvas is actively maintained.
- Our last check on 2026-11-14 found the source still online.
- It is released under the MIT license, a permissive license that allows use, modification and commercial use with attribution.
- Its trust signals score 100/100, with no cautions. These come from repository metadata, not a code audit — read the skill file before letting an agent act on it.
Safety scan
No issues foundOur scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful.
AI review by kimi-k2.7-code on 2026-11-14. Automated pattern scan on 2026-11-14. It catches known dangerous patterns, not every risk — read a skill before letting an agent act on it.
json-canvas compared with similar skills
All 4 of these similar skills score higher than json-canvas; compare them before choosing.
| Skill | Score | Stars | Updated | Format |
|---|---|---|---|---|
| json-canvas (this skill)by obsidianmd | 96 | 52.2k | 5d ago | SKILL.md |
| x402by browser-use | 100 | 121.0k | 3d ago | SKILL.md |
| algorithmic-artby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
| pptxby anthropics | 100 | 177.9k | 55d ago | SKILL.md |
| designby nextlevelbuilder | 100 | 149.0k | 6d ago | SKILL.md |
Frequently asked questions
- How do I install json-canvas?
- Run
npx skills add obsidianmd/obsidian-skills --skill json-canvas. The install tabs above show the steps for each supported agent. - Which AI agents does json-canvas work with?
- It is written for Universal, as a SKILL.md file. Other agents that read the same format can often use it too.
- Is json-canvas safe to use?
- Our scan of the whole file found no instruction hijacking, hidden characters, credential access, data exfiltration or destructive commands. An AI review of the same text found nothing harmful. It is MIT-licensed and scores 100/100 on trust signals. Skills are instructions an agent will follow, so read the file before installing it and do not approve commands you do not understand.
- Is json-canvas still maintained?
- The repository was last updated 5 days ago, so json-canvas is actively maintained.
Skill content
View source on GitHubname: json-canvas description: Create and edit JSON Canvas files (.canvas) with nodes, edges, groups, and connections. Use when working with .canvas files, creating visual canvases, mind maps, flowcharts, or when the user mentions Canvas files in Obsidian.
JSON Canvas Skill
File Structure
A canvas file (.canvas) contains two top-level arrays following the JSON Canvas Spec 1.0:
{
"nodes": [],
"edges": []
}
nodes(optional): Array of node objectsedges(optional): Array of edge objects connecting nodes
Common Workflows
1. Create a New Canvas
- Create a
.canvasfile with the base structure{"nodes": [], "edges": []} - Generate unique 16-character hex IDs for each node (e.g.,
"6f0ad84f44ce9c17") - Add nodes with required fields:
id,type,x,y,width,height - Add edges referencing valid node IDs via
fromNodeandtoNode - Validate: Parse the JSON to confirm it is valid. Verify all
fromNode/toNodevalues exist in the nodes array
2. Add a Node to an Existing Canvas
- Read and parse the existing
.canvasfile - Generate a unique ID that does not collide with existing node or edge IDs
- Choose position (
x,y) that avoids overlapping existing nodes (leave 50-100px spacing) - Append the new node object to the
nodesarray - Optionally add edges connecting the new node to existing nodes
- Validate: Confirm all IDs are unique and all edge references resolve to existing nodes
3. Connect Two Nodes
- Identify the source and target node IDs
- Generate a unique edge ID
- Set
fromNodeandtoNodeto the source and target IDs - Optionally set
fromSide/toSide(top, right, bottom, left) for anchor points - Optionally set
labelfor descriptive text on the edge - Append the edge to the
edgesarray - Validate: Confirm both
fromNodeandtoNodereference existing node IDs
4. Edit an Existing Canvas
- Read and parse the
.canvasfile as JSON - Locate the target node or edge by
id - Modify the desired attributes (text, position, color, etc.)
- Write the updated JSON back to the file
- Validate: Re-check all ID uniqueness and edge reference integrity after editing
Nodes
Nodes are objects placed on the canvas. Array order determines z-index: first node = bottom layer, last node = top layer.
Generic Node Attributes
| Attribute | Required | Type | Description |
|-----------|----------|------|-------------|
| id | Yes | string | Unique 16-char hex identifier |
| type | Yes | string | text, file, link, or group |
| x | Yes | integer | X position in pixels |
| y | Yes | integer | Y position in pixels |
| width | Yes | integer | Width in pixels |
| height | Yes | integer | Height in pixels |
| color | No | canvasColor | Preset "1"-"6" or hex (e.g., "#FF0000") |
Text Nodes
| Attribute | Required | Type | Description |
|-----------|----------|------|-------------|
| text | Yes | string | Plain text with Markdown syntax |
{
"id": "6f0ad84f44ce9c17",
"type": "text",
"x": 0,
"y": 0,
"width": 400,
"height": 200,
"text": "# Hello World\n\nThis is **Markdown** content."
}
Newline pitfall: Use \n for line breaks in JSON strings. Do not use the literal \\n -- Obsidian renders that as the characters \ and n.
Quote escaping pitfall: Double quotes inside text content must be escaped as \". For example, the text 公司的"外交官" must be stored as "text": "公司的\"外交官\"". Unescaped quotes break the JSON parse and the canvas will fail to render. When generating canvas JSON programmatically, always use a JSON serializer rather than manual string concatenation.
Write .canvas files directly. Don't create them with obsidian create content=, which turns every \n into a raw newline and breaks the JSON.
File Nodes
| Attribute | Required | Type | Description |
|-----------|----------|------|-------------|
| file | Yes | string | Path to file within the system |
| subpath | No | string | Link to heading or block (starts with #) |
File path escaping: If a file name contains double quotes, they must be escaped as \" in the JSON string. For example, a file named My "Notes".md should be referenced as "file": "My \"Notes\".md".
{
"id": "a1b2c3d4e5f67890",
"type": "file",
"x": 500,
"y": 0,
"width": 400,
"height": 300,
"file": "Attachments/diagram.png"
}
Link Nodes
| Attribute | Required | Type | Description |
|-----------|----------|------|-------------|
| url | Yes | string | External URL |
{
"id": "c3d4e5f678901234",
"type": "link",
"x": 1000,
"y": 0,
"width": 400,
"height": 200,
"url": "https://obsidian.md"
}
Group Nodes
Groups are visual containers for organizing other nodes. Position child nodes inside the group's bounds.
| Attribute | Required | Type | Description |
|-----------|----------|------|-------------|
| label | No | string | Text label for the group |
| background | No | string | Path to background image |
| backgroundStyle | No | string | cover, ratio, or repeat |
{
"id": "d4e5f6789012345a",
"type": "group",
"x": -50,
"y": -50,
"width": 1000,
"height": 600,
"label": "Project Overview",
"color": "4"
}
Edges
Edges connect nodes via fromNode and toNode IDs.
| Attribute | Required | Type | Default | Description |
|-----------|----------|------|---------|-------------|
| id | Yes | string | - | Unique identifier |
| fromNode | Yes | string | - | Source node ID |
| fromSide | No | string | - | top, right, bottom, or left |
| fromEnd | No | string | none | none or arrow |
| toNode | Yes | string | - | Target node ID |
| toSide | No | string | - | top, right, bottom, or left |
| toEnd | No | string | arrow | none or arrow |
| color | No | canvasColor | - | Line color |
| label | No | string | - | Text label |
{
"id": "0123456789abcdef",
"fromNode": "6f0ad84f44ce9c17",
"fromSide": "right",
"toNode": "a1b2c3d4e5f67890",
"toSide": "left",
"toEnd": "arrow",
"label": "leads to"
}
Colors
The canvasColor type accepts either a hex string or a preset number:
| Preset | Color |
|--------|-------|
| "1" | Red |
| "2" | Orange |
| "3" | Yellow |
| "4" | Green |
| "5" | Cyan |
| "6" | Purple |
Preset color values are intentionally undefined -- applications use their own brand colors.
ID Generation
Generate 16-character lowercase hexadecimal strings (64-bit random value):
"6f0ad84f44ce9c17"
"a3b2c1d0e9f8a7b6"
Layout Guidelines
- Coordinates can be negative (canvas extends infinitely)
xincreases right,yincreases down; position is the top-left corner- Space nodes 50-100px apart; leave 20-50px padding inside groups
- Align to grid (multiples of 10 or 20) for cleaner layouts
| Node Type | Suggested Width | Suggested Height | CJK Width (1.5x) | |-----------|-----------------|------------------|-------------------| | Small text | 200-300 | 80-150 | 300-450 | | Medium text | 300-450 | 150-300 | 450-675 | | Large text | 400-600 | 300-500 | 600-900 | | File preview | 300-500 | 200-400 | 450-750 | | Link preview | 250-400 | 100-200 | 375-600 |
CJK text sizing: CJK characters (Chinese, Japanese, Korean) are wider than Latin characters. For content primarily in CJK languages, multiply the suggested width by ~1.5× to avoid cramped layouts and awkward line breaks.
Validation Checklist
After creating or editing a canvas file, verify:
- All
idvalues are unique across both nodes and edges - Every
fromNodeandtoNodereferences an existing node ID - Required fields are present for each node type (
textfor text nodes,filefor file nodes,urlfor link nodes) typeis one of:text,file,link,groupfromSide/toSidevalues are one of:top,right,bottom,leftfromEnd/toEndvalues are one of:none,arrow- Color presets are
"1"through"6"or valid hex (e.g.,"#FF0000") - Double quotes in
textandfilevalues are properly escaped as\" - JSON is valid and parseable
If validation fails, check for duplicate IDs, dangling edge references, or malformed JSON strings (especially unescaped newlines in text content).
Complete Examples
See references/EXAMPLES.md for full canvas examples including mind maps, project boards, research canvases, and flowcharts.
References
Related Skills
x402
121.0kSet up Browser Use Cloud payments with x402 — pay per request from a crypto wallet (USDC on Base mainnet), no signup or API key.
algorithmic-art
177.9kCreating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems.
pptx
177.9kUse this skill any time a .pptx or .potx file is involved in any way — as input, output, or both. This includes: creating slide decks, pitch decks, or presentations; reading, parsing, or extracting text from any .pptx or .potx file (even if the extracted content will be used elsewhere, like in an em…
design
149.0kComprehensive design skill: brand identity, design tokens, UI styling, logo generation (55 styles, Gemini, Atlas Cloud, or MuAPI AI), corporate identity program (50 deliverables, CIP mockups), HTML presentations (Chart.js), banner design (22 styles, social/ads/web/print), icon design (15 styles, SVG…
Languages
Trust signals
From repository metadata: license, adoption, age and documentation. Not a code audit — see the Safety scan above for what the skill file itself contains.
