Readied Documentation
Technical documentation for Readied — Markdown-first, offline-forever desktop note app for developers
Readied Documentation
Readied is a Markdown-first desktop note app for developers who value their data.
Features
- Markdown Sacred — Your markdown is never auto-modified. What you type is exactly what gets saved. No hidden transformations.
- Plugin System — 8 built-in plugins with an extensible architecture. Load community plugins from
~/.config/readied/plugins. - Offline First — Works 100% offline by default. Optional cloud sync via Supabase keeps your notes in sync across devices when you want it.
- Portable Data — Export anytime as markdown files. Import from Obsidian. Your notes survive the app — always.
- Fast & Native — Built with Electron for cross-platform support. CodeMirror 6 editor for blazing fast editing.
- Theme System — Customizable color palettes with dark/light awareness. Ships with Solarized built-in. Make Readied yours.
Quick Links
- Get Started — Installation and first launch
- Principles — Understand the philosophy
- Architecture — How it all works
- Plugin Development — Build your own plugins
- ADRs — Key technical decisions