The Markdown Editor That Gets It Right
Free. Smart. Beautiful. Yours.
VMark is a modern, local-first Markdown editor designed for the AI era. It combines the simplicity of rich text editing with the power of source mode — clean when you need focus, powerful when you need control.
Download · Documentation · Features
VMark is a vibe-coded codebase — written almost entirely by AI. The human maintainer guides the AI but does not review code line-by-line in the traditional sense. This has a practical consequence:
We cannot safely merge pull requests from other contributors. When one person's AI-generated code meets another person's AI-generated code, neither human can fully vouch for what's inside. The risk of subtle regressions is too high.
What we welcome:
- Issues — Bug reports, feature requests, and suggestions are very welcome. The more detailed, the better. Feel free to use AI to write comprehensive, well-structured issues.
- Discussions — Architecture ideas, UX feedback, workflow suggestions.
What happens next:
When you file an issue, AI fixes the codebase under the maintainer's supervision — with full context of the project's conventions, test suite, and architecture. This keeps the codebase consistent and well-tested.
Templates:
Why no "Co-authored-by: Claude" in commits?
VMark is built with multiple AI tools — Claude Code, Codex CLI, and Gemini CLI. Only Claude automatically adds a Co-authored-by trailer to commits. Codex and Gemini do not. Giving credit to one AI while the others contribute silently would misrepresent how this project is built. Since there's no fair way to attribute every AI involved, we turned off Co-authored-by entirely. The commit history belongs to the maintainer who supervised the work.
Read more: Why Issues, Not PRs
Built to work seamlessly with AI assistants. Claude, Codex, and Gemini can read your documents, suggest edits, and write content directly — no plugins required.
- One-click setup for Claude Desktop, Claude Code, Codex CLI, Gemini CLI
- AI suggestions appear inline for your review
- Accept or reject changes with a keystroke
Finally, a Markdown editor that understands Chinese, Japanese, and Korean text. Smart spacing between CJK and Latin characters, proper punctuation handling, and 19+ formatting rules — all built in.
- Automatic CJK-Latin spacing
- Fullwidth punctuation conversion
- Corner bracket quotes for CJK
- One shortcut to fix everything:
Alt + Cmd + Shift + F
Switch instantly between rich text (WYSIWYG) and source mode. See your formatting rendered beautifully, or dive into the Markdown source when you need precision.
- Rich text mode powered by Tiptap/ProseMirror
- Source mode powered by CodeMirror 6
- Toggle with
Cmd + /
Five hand-crafted themes designed for extended writing sessions. Typography that respects your fonts. An interface that stays out of your way.
- White — Clean and minimal
- Paper — Warm and gentle
- Mint — Fresh and focused
- Sepia — Classic reading feel
- Night — Easy on the eyes
Your documents stay on your machine. No cloud services, no accounts, no tracking. VMark works entirely offline.
| Category | What You Get |
|---|---|
| Editing | Rich text, source mode, focus mode, typewriter mode |
| Formatting | Headings, lists, tables, code blocks, blockquotes |
| Advanced | Math equations (LaTeX), Mermaid diagrams, wiki links |
| AI Integration | MCP support for Claude, Codex, Gemini |
| CJK | 19+ formatting rules for Chinese, Japanese, Korean |
| Customization | 165 keyboard shortcuts, 5 themes, font controls |
| Export | HTML, PDF, copy as HTML |
Homebrew:
brew install xiaolai/tap/vmarkManual Download:
Download the .dmg from the Releases page.
- Apple Silicon (M1/M2/M3):
VMark_x.x.x_aarch64.dmg - Intel:
VMark_x.x.x_x64.dmg
Pre-built binaries are available on the Releases page. Active development is focused on macOS; Windows and Linux builds are provided as-is.
VMark speaks MCP (Model Context Protocol) natively. Connect your favorite AI assistant in one click:
- Open Settings → Integrations
- Enable MCP Server
- Click Install for your AI assistant
- Restart the AI assistant
That's it. Your AI can now read, edit, and write to your VMark documents.
Supported assistants:
- Claude Desktop
- Claude Code
- Codex CLI
- Gemini CLI
VMark has 165 customizable shortcuts. Here are the essentials:
| Shortcut | Action |
|---|---|
Cmd + / |
Toggle Rich Text / Source Mode |
F8 |
Toggle Focus Mode |
F9 |
Toggle Typewriter Mode |
Cmd + S |
Save |
Cmd + Shift + V |
Paste as Plain Text |
Alt + Cmd + Shift + F |
Format CJK Text |
See the full list in Settings → Keyboard Shortcuts or the documentation.
- Getting Started — First steps with VMark
- Features — Complete feature overview
- Keyboard Shortcuts — All 165 shortcuts
- CJK Formatting — CJK text handling
- MCP Setup — AI integration guide
- MCP Tools — Complete MCP reference
For developers who want to contribute or build VMark locally.
- Node.js 18+
- pnpm 8+
- Rust (latest stable)
- Tauri Prerequisites
# Clone
git clone https://github.com/xiaolai/vmark.git
cd vmark
# Install dependencies
pnpm install
# Run in development mode
pnpm tauri dev
# Build for production
pnpm tauri build| Command | Description |
|---|---|
pnpm tauri dev |
Start development mode |
pnpm test |
Run tests |
pnpm lint |
Run linter |
pnpm check:all |
Lint + test + build |
vmark/
├── src/ # React frontend
├── src-tauri/ # Rust backend (Tauri)
├── vmark-mcp-server/ # MCP server
├── website/ # Documentation (VitePress)
└── plugins/ # Claude Code skills
- Framework: Tauri v2 (Rust backend)
- Frontend: React 19, TypeScript, Zustand
- Rich Editor: Tiptap (ProseMirror)
- Source Editor: CodeMirror 6
- Styling: Tailwind CSS v4
The repo ships with full configuration for AI coding tools (Claude Code, Codex CLI, Gemini CLI). Project rules, conventions, and architecture docs are pre-loaded — the AI already knows how VMark works.
AGENTS.md— Single source of truth for all AI tool instructions.claude/— Rules, slash commands, skills, and subagent definitions (developer guide).mcp.json— MCP server config (Codex for cross-model auditing, Tauri for E2E testing)
See the Users as Developers guide for details.
Private - All rights reserved.
Questions? Open an issue · Updates? Watch this repo