Prerequisites
- Node.js 20+
- pnpm 9+
- Git
- A local folder to use as your vault (any directory of Markdown files)
Clone and install
1
Clone the repository
2
Install dependencies
3
Run the desktop app
4
Run tests (optional)
Your first typed note
Once the app is running and a vault is open, create a Type and a typed note.1
Define a Type
Create
.zorid/types/task.ztype in your vault:2
Create a typed note
Create Zorid renders the
Tasks/Fix sync conflict UI.md:Task field group above the note body.3
Embed a view
Create Embed it from any Markdown note:
.zorid/views/tasks.zbase:Next steps
Storage model
Where Markdown,
.zbase, .ztype, and the SQLite index live.Fields and Types
How frontmatter fields and
.ztype schemas work together..zbase schema
View schema and the v0 filter grammar.
Core plugins
What ships in the box for v0.