Skip to content

A confluence macro to render .canvas files which follow the JSON canvas spec. Initial purpose is to render diagrams created in Obsidian

Notifications You must be signed in to change notification settings

xPhentom/JSON-canvas-viewer

Repository files navigation

JSON canvas viewer

Why?

I was trying to create a canvas in Obsidian and share this with my colleagues in a meeting. But how would I go around sharing this canvas? Sure, I could go ahead and share an image, which I'm currently doing. But it's not interactive, sometimes clumsy to zoom and navigate and depending on where you share it, the quality plummets.

What?

For better interactivity, I've now created this Confluence macro. It's still a work in progress based on my needs and not yet on the marketplace. It lets the user upload a .canvas which is based on the JSON canvas spec.

The render engine currently is React flow. The connections are animated(i.e.: https://reactflow.dev/learn/concepts/built-in-components#controls), but I'm open to changing them to arrows instead.

standard canvas example

Development

Pull in the repo, npm install on the root folder and the static/json-canvas-viewer folder.

After using npm build in static/json-canvas-viewer, you can use Forge to deploy and install the macro on your confluence site.

Use npm start for local development. You'll probably need to set up tunneling.

About

A confluence macro to render .canvas files which follow the JSON canvas spec. Initial purpose is to render diagrams created in Obsidian

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published