Documentation
mdai is a local-first Markdown editor for macOS, Windows and Linux. Your
notes are plain .md files in a folder you choose (a vault), and every
feature below reads those files rather than a database of its own.
Getting started
Section titled “Getting started”- Install — download and first launch, per operating system
- Your first vault — open a folder and start writing
Writing
Section titled “Writing”- The editor — the live document, tabs and split view, the outline, slash commands, callouts, columns, code blocks, images, Focus mode
- Writing Mode, Focus and Typewriter — clear the screen around the text you are writing
- Tables, math and diagrams — a table toolbar,
$…$formulas, Mermaid diagrams - Properties and Today’s note — frontmatter above the note and in a panel, a dated note for today, and Quick Capture from any app
- Templates — where they live, the three examples, every placeholder
Your vault
Section titled “Your vault”- Vault and files — the file tree, new notes and folders, moving and the Trash, folder notes, unused images, pinned notes, watching the folder, Rescan Vault
- Finding things — command palette, quick switcher with recent files, full-text search
- Graph — how your notes link together
- File History, backups and differences — earlier versions, an encrypted zip of the vault, what changed on disk
- Git — changed files and commits from mdai
Connecting notes
Section titled “Connecting notes”- Wikilinks and backlinks —
[[link]]by name, embeds of a section or a block, what points back, and unlinked mentions - Tags — every
#tagin the vault, counted, with its lines
Getting things done
Section titled “Getting things done”- Tasks — checkboxes, tags and dates across every note
- Calendar — the dated ones, laid out on the month
- AI setup — your own provider key, or local AI with Ollama
- Ask vault and saved prompts — answers from your notes, prompts one click away
- External agents (MCP) — let an agent such as Claude Code read your notes and propose changes
The rest
Section titled “The rest”- Settings — every setting, and where it is
- Export and sharing — PDF, HTML, clean Markdown
- Keyboard shortcuts — every key, and the ones that do not exist on purpose
- FAQ — pricing, trial, licenses, privacy
- Troubleshooting
Everything shipped is listed on the roadmap, and what changed in each version is on releases.