
solomd
io.github.zhitongblog/solomd
Read and search a folder of Markdown notes: search, backlinks, tags, tasks, outlines, git history.
Documentation
SoloMD
All the calm of Typora. Plus 5-platform vault sync, 9-format export & local AI โ free.
๐ ไธญๆ ยท ๆฅๆฌ่ช ยท ํ๊ตญ์ด ยท Deutsch ยท Franรงais ยท Espaรฑol ยท Portuguรชs ยท Italiano ยท Polski ยท Nederlands ยท Tรผrkรงe ยท Svenska ยท ะฃะบัะฐัะฝััะบะฐ ยท ๐ช AtomGit mirror โ ยท Gitee mirror โ (faster downloads from China)
Download v5.2.0 ยท AtomGit Releases ยท What's new in v5.2 ยท Compare vs Obsidian & Typora ยท Website ยท Security
โญ If SoloMD earns a place on your machine, star it on GitHub โ it's free, made by one developer, and stars are how other people find it.
๐ค Built and maintained by Claude
SoloMD is written, tested and released almost entirely by Claude Code, Anthropic's coding agent, working under a human maintainer who sets the direction and decides what ships. Issues and pull requests are triaged and answered by Claude as well โ the replies you get here are written by an AI, not typed by a person.
We are telling you this for two reasons. You should know what you are trusting with your notes: read the code, it is MIT and all of it is public. And when a reply is confidently wrong โ it happens โ say so in the thread. That correction is the mechanism.
๐ผ For Teams & Founders (100% Async Contracts): Using this exact human-architect + Claude Code pipeline, the maintainer also built Unterm โ a self-developed Rust + wgpu terminal kernel exposing 152 MCP methods with an Action Gateway. Available for 100% asynchronous remote contracts (custom MCP servers, Rust/Tauri agentic desktop apps, and AI workflows โ written specs, Loom demos & clean PRs, zero meetings). Work with the architect โ
Your notes live in a plain folder. SoloMD gives you Typoraโs quiet, centered writing feel, Obsidianโs local-first vault links, free encrypted sync across all 5 platforms, built-in 9-format export, and zero-config local AI + a 16-tool MCP server.
Built on Tauri 2 + Vue 3 + CodeMirror 6 + Rust. ~14 MB on Windows, ~16 MB on Linux (.deb/.rpm), ~21 MB on Android (arm64), and ~30 MB for the dual-arch macOS Universal .dmg. Free, MIT-licensed, no account, no subscription, no plugin tax, no SoloMD-hosted servers. Your notes, AI keys, embeddings index, and git history stay on your device.
What's new in v5.0 โ v5.2
- Three seamless writing modes (
v5.2) โ Switch anytime between Pure WYSIWYG (Markdown syntax markers stay completely hidden even on the active caret line), Live Preview (markers reveal only on the active line), and synced Split / Source view. - Unified 9-Format Export Center (
v5.2) โ One modal with live preview exports PDF (with KaTeX & Mermaid), Word (.docx), HTML, EPUB, LaTeX, ODT, RTF, Plain Text, and Markdown out of the box โ zero external Pandoc installation required. - Zero-config local AI (OPR) + 20+ BYOK providers (
v5.2) โ One-click Open Provider Registry (OPR) auto-discovery detects local Ollama, LM Studio, Jan, vLLM, and llama.cpp servers on localhost. Or plug in your own API key for 20+ cloud providers (OpenAI, Claude, Gemini, DeepSeek, Qwen, GLM, Kimi, Doubao, MiniMax, Groq, Mistral, xAI, SiliconFlow, OpenRouter, etc.) stored in your OS keychain. - Vault-scoped encrypted Cloud & Git sync (
v5.2) โ Bind each workspace independently to iCloud Drive, OneDrive, Nutstore, Baidu/Aliyun Drive, Syncthing, WebDAV, S3 / Cloudflare R2, or GitHub / GitLab / Gitea โ with optional AES-256-GCM / XChaCha20-Poly1305 end-to-end encryption and conflict copy protection. - Lightweight declarative JSON extensions (
v5.2) โ Drop simple JSON manifests into<workspace>/.solomd/plugins/*.json(or manage via Settings โ Extensions) to add custom/slash templates, regex/template Command Palette transforms, and one-click Webhook publishers โ zero Electron plugin bloat. - CLI v2 & 16-tool MCP server (
v5.2) โsolomd open / new / list / search / export / daily / agent / mcpfrom your terminal, plussolomd-mcpwith multi-vault--workspacefederation.
Three pillars in one lightweight native app
- Calm writing & publishing. Pure WYSIWYG + Live Preview + Split view, floating selection formatting bar, Focus & Typewriter modes, fullscreen Slideshow (
โโฅP), Vim mode, KaTeX math + Mermaid diagrams, image paste to_assets/, built-in 9-format export, and.docx / .pdf / .xlsx / .pptxdrag-and-drop import to Markdown. First-class CJK encoding detection (UTF-8 / GBK / Big5 / Shift-JIS), character counts, and Simplified โ Traditional conversion. - Connected local vault across 5 platforms. Native apps for macOS, Windows (x64 + ARM64), Linux (x64 + ARM64), iOS/iPadOS, and Android with cross-device session restore.
[[Wikilinks]], backlinks, YAML frontmatter properties, 100% offline semantic RAG search (โโงF), AutoGit snapshot on everyโS(libgit2 built in), and free vault-scoped encrypted sync. - Local AI & MCP endpoint. Inline AI rewrite (
โJ), right-side Agent Panel (streamed chat-with-vault,[[wikilink]]citations, inline tool cards), OPR local model auto-discovery + 20+ BYOK providers, and the bundledsolomd-mcpbinary exposing 16 tools to Claude Desktop, Cursor, Windsurf, and Claude Code.
| Feature | What it does |
|---|---|
| 3 Editing Modes (v5.2) | Pure WYSIWYG (no syntax shift on active line), Live Preview, and synced Split / Source view. |
| Unified 9-Format Export (v5.2) | Built-in live-preview export to PDF, DOCX, HTML, EPUB, LaTeX, ODT, RTF, TXT, and MD โ no external Pandoc setup needed. |
| Vault-Scoped Cloud & Git Sync (v5.2) | Per-workspace sync via iCloud, OneDrive, Nutstore, Baidu/Aliyun Drive, Syncthing, WebDAV, S3/R2, or GitHub/GitLab/Gitea with optional E2EE. |
| OPR Local AI + 20+ BYOK (v5.2) | Auto-discover local Ollama / LM Studio / Jan / vLLM / llama.cpp, or use 20+ BYOK cloud providers. Keys live in your OS keychain. |
| Declarative JSON Extensions (v5.2) | .solomd/plugins/*.json adds custom /slash templates, regex/template text transforms, and one-click Webhook publishing. |
| Agent Panel & AI Rewrite | Streamed chat-with-vault ([[wikilink]] citations, Insert/Copy to note) and โJ inline selection rewrite/translate. |
| Bundled 16-Tool MCP Server | solomd-mcp ships in the app. Supports --workspace path1 --workspace path2 multi-vault federation, stdio (default) and loopback Streamable HTTP. |
| AutoGit per note | Every โS commits a snapshot to a local .git inside your workspace. libgit2 vendored, no system git required. Visual diff & 1-click rollback. |
| Offline Semantic Search (RAG) | โโงF ranks paragraphs by meaning across your vault using an on-device Rust embedder โ zero model downloads, zero network calls. |
Use it
1. Write, link, and export. Open any folder of .md files. Switch between Pure WYSIWYG, Live Preview, and Split view in the top header; press โโงE (or File โ Export) to open the Unified 9-Format Export Center.
2. Chat with your vault or rewrite inline. Select text and press โJ for inline AI rewrite/translation, or open the right-side Agent Panel (โโงP โ View: Toggle Agent Panel) for multi-turn chat across your notes. Click Auto-detect Local Models in Settings โ AI to connect local Ollama / LM Studio in one click.
3. Drive your vault from Claude Desktop, Cursor, or Claude Code:
# Print the MCP config snippet for your AI clientโฆ
solomd mcp-config
# โฆor register it automatically across AI clients on your machine:
solomd mcp install
{
"mcpServers": {
"solomd": {
"command": "/Applications/SoloMD.app/Contents/MacOS/solomd-mcp",
"args": ["--workspace", "/Users/me/Documents/SoloMD"]
}
}
}
For multi-vault federation, repeat --workspace:
"args": [
"--workspace", "/Users/me/Documents/SoloMD",
"--workspace", "/Users/me/Documents/work-notes"
]
4. Or hand a prompt to claude / codex CLI directly:
solomd agent "summarize this week's daily notes into a weekly review and commit it"
MCP tools (16 built in)
| Kind | Tools |
|---|---|
| Read (always on) | list_notes, read_note, search, get_backlinks, get_outline, list_tags, list_tasks, autogit_log, autogit_diff, sync_status, share_url, read_agent_trace |
Write (--allow-write) | write_note, append_to_note, autogit_rollback, export_note |
Transports: stdio (default, what Claude Desktop / Cursor / Cline / Codex use), or Streamable HTTP for local/hosted clients:
solomd-mcp --workspace ~/Documents/SoloMD --transport http --bind 127.0.0.1:8765 --auth-token "$TOKEN"
Command line (CLI v2)
curl -fsSL https://raw.githubusercontent.com/zhitongblog/solomd/main/scripts/install-cli.sh | bash
solomd help
Commands: open, new, daily, list, search, cat, export, agent, mcp list|install|uninstall|config, mcp-config, --version.
Install
Latest release (v5.2.0) and every download: GitHub Releases ยท AtomGit Mirror ยท Gitee Mirror.
System requirements: Windows 10+, macOS 10.15+, current mainstream Linux, iOS 15+, Android 7+ (API 24).
macOS โ universal dmg (Apple Silicon + Intel, signed + notarized)
brew install --cask zhitongblog/solomd/solomd
Or one-line shell install:
curl -fsSL https://solomd.app/install.sh | bash
Or direct download: SoloMD_5.2.0_universal.dmg ยท Mac App Store
Windows โ x64 & ARM64
SoloMD_5.2.0_x64_en-US.msi/SoloMD_5.2.0_arm64_en-US.msi/ portable.zipon the releases page
irm https://solomd.app/install.ps1 | iex
winget install solomd
Linux โ x86_64 + aarch64
.AppImage(universal),.deb(Debian/Ubuntu),.rpm(Fedora/RHEL) โ both architectures on the releases page.- Arch Linux:
solomd-binon AUR.
iOS / iPadOS & Android
- iPhone & iPad: App Store
- Android: Google Play or direct
SoloMD_5.2.0_universal.apk
Compared
| SoloMD v5.2 | Obsidian | Typora | MarkText | |
|---|---|---|---|---|
| License | MIT (Open Source) | Proprietary (free) | Paid ($14.99) | MIT (dormant since 2023) |
| Stack | Tauri 2 (Rust + native WebView) | Electron | Electron | Electron |
| Platforms | macOS ยท Win ยท Linux ยท iOS ยท Android | macOS ยท Win ยท Linux ยท iOS ยท Android | macOS ยท Win ยท Linux | macOS ยท Win ยท Linux |
| Installer | ~14 MB (Win) / ~16 MB (Linux) / ~30 MB (Mac Universal) | ~110 MB | ~70 MB | ~80 MB |
| Pure WYSIWYG + Live Preview + Split | โ All 3 modes | ๐ก Live Preview only | โ | โ |
| Built-in 9-format export (no Pandoc install) | โ v5.2 | ๐ก PDF only (plugins for others) | ๐ก Requires external Pandoc | โ |
| Free vault-scoped cloud & Git sync | โ iCloud / OneDrive / WebDAV / S3 / Git | โ ($96/yr Obsidian Sync) | โ | โ |
| End-to-end encryption | โ On your own storage | โ Paid Obsidian Sync only | โ | โ |
| Zero-config local AI (OPR auto-detect) | โ Ollama / LM Studio / Jan / vLLM | ๐ก Community plugins | โ | โ |
| BYOK AI providers built in | โ 20+ providers (OS keychain) | ๐ก 1โ2 per community plugin | โ | โ |
| MCP server bundled | โ 16 tools + multi-vault federation | โ (community plugins) | โ | โ |
| Declarative JSON extensions | โ
.solomd/plugins/*.json | โ Heavy JS plugins | โ | โ |
| Local semantic RAG search | โ 100% offline in Rust | ๐ก Community plugins | โ | โ |
| Version history per note | โ AutoGit (libgit2 built in) | ๐ก Manual git plugin | โ | โ |
| CJK encodings (GBK / Big5) + OpenCC | โ Auto-detect | โ | โ | โ |
Detailed breakdowns: vs Obsidian ยท vs Typora ยท vs Tolaria ยท vs MarkText.
Privacy & security
Pure client-side. Your .md files stay in the folder you chose. API keys live in the OS keychain (macOS Keychain / Windows Credential Manager / Linux libsecret), never in localStorage or any config file. AI requests go direct from your machine to the provider you picked โ no SoloMD relay. RAG embeddings and the AutoGit repo are local-only. The MCP server speaks stdio by default; its optional HTTP transport binds to loopback unless you choose otherwise, and can require a bearer token. The whole codebase is MIT and auditable.
E2EE sync uses AES-256-GCM (.solomd-enc cloud drive sync) and Argon2id โ XChaCha20-Poly1305 (Git/remote sync). Plaintext stays on your devices; the remote sees only ciphertext. Path-traversal guards reject .. segments and unauthorized paths across all Tauri and MCP endpoints.
Full writeup: https://solomd.app/security.
Build from source
Prereqs: Rust (stable), Node 18+, pnpm.
git clone https://github.com/zhitongblog/solomd.git
cd solomd/app
pnpm install
pnpm tauri dev # dev with hot reload
pnpm tauri build # release artifacts โ src-tauri/target/release/bundle/
Linux additionally needs libdbus-1-dev for the keychain backend.
The MCP server is a separate crate at mcp-server/; the dev MCP harness used for end-to-end testing lives at dev-mcp/. End-to-end test entry point: scripts/v4-self-test.sh (run with --with-release --with-ollama --with-ui for full coverage).
Contributing
Issues and PRs welcome โ open one. For a sense of direction, see docs/roadmap.md. The v4.0 build log is at solomd.app/blog/v4-0-0-how-we-built-it/ โ start there if you want to understand the engineering principles before sending a PR.
Contact / ่็ณป
One maintainer, two front doors. Async on GitHub Discussions. Real-time chat:
- Telegram (international): @SOLOMDAPP โ release announcements + chat
- WeChat (ไธญๆ): scan to add me โ note "SoloMD" ๆณจๆ SoloMD ็ดๆฅ้่ฟ
Sponsors
Thank you to everyone who sponsors SoloMD: tyysoft(ๅคช้ณ้จ)
(Note: This is a partial opt-in list โ WeChat Pay, Alipay, and App Store / Google Play in-app tips are anonymous by default. If you supported SoloMD and would like your name listed, please open an issue or see solomd.app/thanks.)
โจ 100% Free Forever & Supporter Badge: Every feature in SoloMD is 100% free forever โ no paywalls, no subscriptions, no ads. To support independent open-source development, you can sponsor via GitHub Sponsors / PayPal / Alipay / WeChat Pay, or use the 3 optional one-time in-app tip tiers on Mac App Store, iOS App Store, and Google Play (
โ Buy a Coffee $0.99ยท๐ Buy a Lunch $2.99ยท๐ Generous Support $9.99) to permanently unlock the exclusiveโจ Supporterbadge in Settings and About.
Contributors
Thank you to everyone who helps make SoloMD better โ sponsors ๐ต, testers ๐๐ค, code/theme/packaging contributors ๐ป๐จ๐ฆ and promoters ๐ฃ (All Contributors spec). Full wall of thanks: solomd.app/thanks ยท Promote SoloMD: solomd.app/promote
License & credits
MIT ยฉ 2026 xiangdong li. SoloMD stands on Tauri 2, Vue 3, CodeMirror 6, markdown-it, KaTeX, Mermaid, libgit2, Pandoc, Hunspell, keyring-rs, and rmcp. Sponsor on GitHub Sponsors or via solomd.app/#sponsor.
Open-source hosting & G-Star Program
Special thanks to AtomGit (G-Star Program) for hosting SoloMD's official mirror and release packages in mainland China.
https://github.com/zhitongblog/solomd/releases/download/v4.14.11/solomd-mcp-4.14.11.mcpb# mcpb: https://github.com/zhitongblog/solomd/releases/download/v4.14.11/solomd-mcp-4.14.11.mcpb






































