Skip to content

docs: lead README with what JSON Canvas is, not the renderer stack #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LeslieOA wants to merge 1 commit into
base: develop
Choose a base branch
from
+3 −1
Open

docs: lead README with what JSON Canvas is, not the renderer stack #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# @workspace.sh/react-native-jsoncanvas

React Native renderer for [JSON Canvas](https://jsoncanvas.org/) (`.canvas`) documents. Skia + Reanimated, with pan / pinch / double-tap zoom and an imperative fit / recenter API.
A React Native renderer for [JSON Canvas](https://jsoncanvas.org/) — the open file format for infinite-canvas notes, originally from Obsidian.

Drop a `.canvas` file in and you get a panning, pinch-zooming canvas with text nodes, file nodes (markdown, images, PDFs), grouped nodes, and connecting edges. Gestures are tuned with Skia and Reanimated for 60fps on iOS, macOS, and Android. The library exposes imperative controls for fit-to-viewport and recentre, plus an extension surface for community conventions like Obsidian cssclasses and callouts.

## Install

Expand Down
Loading