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. Open source, offline-first, and built to last.
Getting Started
Installation
Download and install Readied on macOS, Windows, or Linux.
Core Principles
Understand the philosophy behind Readied's design decisions.
Architecture
Deep dive into how Readied works under the hood.
Plugin Development
Build your own plugins to extend Readied's capabilities.
Why Readied?
- Markdown Sacred — Your markdown is never auto-modified. What you type is exactly what gets saved.
- Plugin System — 8 built-in plugins with an extensible architecture for community plugins.
- Offline First — Works 100% offline. Optional cloud sync via Supabase when you want it.
- Portable Data — Export anytime as markdown files. Import from Obsidian. Your notes survive the app.
- Fast & Native — Electron + CodeMirror 6 for a buttery-smooth editing experience.
- Theme System — Customizable color palettes with dark/light awareness.