Help & FAQ
Getting Started
Bunny stores your notes as plain markdown files in a vault — just a folder on your Mac. Open any folder as a vault, or create a new one from the app.
Your notes support standard markdown plus Bunny-specific features like Janet scripting, wiki links, and hierarchical tags.
- Where are my notes stored?
- Bunny is local-first. Your notes live as
.mdfiles in the vault folder you choose. There is no cloud sync yet — you can use any file-syncing tool (iCloud Drive, Syncthing, etc.) to keep vaults in sync across machines. - What are wiki links?
- Type
[[Note Name]]to link to another note in your vault. Links are case-insensitive and auto-complete as you type. The backlinks panel shows which notes reference the current one. - How do tags work?
- Add tags anywhere in a note with
#tag-name. Tags can be hierarchical:#project/bunny/editor. You can rename a tag across your entire vault from the tag panel. - What is Janet?
- Janet is a lightweight Lisp-like language embedded in Bunny. It lets you register custom commands, respond to hooks (like document save), define style rules, and more. See the scripting docs for the full API.
- How do I install extensions?
- Download an extension package and place it under
~/Library/Application Support/Bunny/lib/(global) or<vault>/.vault/extensions/(vault-specific). Then import it from yourinit.janetfile. - How do I submit an extension to the registry?
- Visit the Bunny package registry, add a JSON file to the
packages/directory following the schema, and open a merge request. CI will validate your package automatically. - Can I import notes from Bear or Obsidian?
- Yes. Bunny includes import scripts for both Bear and Obsidian vaults. See the scripting docs for details.