Skip to main content
Zorid is a pnpm monorepo with Electron (desktop) and Capacitor (mobile) shells over a set of shared Vue 3 + TypeScript packages. In v0, the focus is the desktop experience.

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

The Electron window opens and prompts you to select a folder to use as your vault.
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 Tasks/Fix sync conflict UI.md:
Zorid renders the Task field group above the note body.
3

Embed a view

Create .zorid/views/tasks.zbase:
Embed it from any Markdown note:

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.