json-canvas

Create and edit Obsidian Canvas files using the JSON Canvas spec.

515|64|Updated Oct 23, 2024

Search Tags:#obsidian #visualization #canvas #graph #json-canvas

Ready to run

npx skills add https://github.com/allenhutchison/obsidian-gemini --skill json-canvas-allenhutchison

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: json-canvas
Source: https://github.com/allenhutchison/obsidian-gemini/tree/main/prompts/bundled-skills/json-canvas
Command: npx skills add https://github.com/allenhutchison/obsidian-gemini --skill json-canvas-allenhutchison

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Obsidian Canvas files use the open JSON Canvas format: a .canvas file is plain JSON describing nodes (cards) laid out on an infinite spatial board and edges (connections) between them. This standard enables visual representations of notes and ideas inside Obsidian.

Core Features & Use Cases

Write canvas files with the write_file tool by passing the full JSON content and a .canvas extension. The file is treated as text for editing in Obsidian, and renders as a Canvas board in Obsidian's Canvas view.
Read and edit existing canvas data including nodes (text, file, link, group) and edges, allowing iterative diagramming without leaving Obsidian.
Use cases include building mind maps, flowcharts, and knowledge boards that map relationships between notes and resources.

Quick Start

Create a new canvas with two text nodes and a connecting edge and save it as board.canvas.

Frequently Asked Questions about json-canvas

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I create an Obsidian Canvas file from JSON?▼

To create an Obsidian Canvas file from JSON, you write the full JSON Canvas content and save it with a .canvas file extension. The file is saved as plain text and renders as a visual board inside Obsidian.

Can I edit existing Obsidian Canvas data without leaving the app?▼

Yes, you can read and edit existing Canvas data, including nodes like text, file, link, and group elements, as well as edges. This allows for iterative diagramming without leaving Obsidian.

What is the JSON Canvas spec used for in Obsidian?▼

The JSON Canvas spec is an open format used to describe nodes and edges on an infinite spatial board. It enables visual representations of notes, ideas, and resources inside Obsidian.

What can I build using the JSON Canvas format?▼

Using the JSON Canvas format, you can build mind maps, flowcharts, and visual knowledge boards. These canvases map relationships between your vault notes and external resources.

Do I need a specific file extension to write Obsidian Canvas files?▼

Yes, you need to use the .canvas file extension when writing the JSON content. The write_file tool saves the text, and Obsidian renders it as a Canvas board in its Canvas view.