VMark is a modern, local-first Markdown editor designed for the AI era, offering a smart, beautiful, and customizable editing experience. It targets developers, researchers, and power users who need robust Markdown capabilities integrated with AI tools, providing a private and efficient environment for document creation and management.

How It Works

VMark employs a local-first architecture, ensuring all documents remain on the user's machine without cloud reliance or analytics. It features three distinct editing modes: WYSIWYG (powered by Tiptap/ProseMirror), Source Peek (accessible via F5), and full Source Mode (using CodeMirror 6, via F6). A key differentiator is its AI-native design, featuring native MCP integration for popular AI assistants like Claude and Gemini, alongside "AI Genies" for inline writing assistance. Additional features include multi-cursor editing, automatic bracket/quote pairing with "Tab Escape," and specialized formatting rules for CJK languages.

Quick Start & Requirements

• Primary Install (macOS): brew install xiaolai/tap/vmark
• Manual Install: Download .dmg (Apple Silicon/Intel) or pre-built binaries from the Releases page. macOS is the primary platform; other builds are best-effort.
• Build Prerequisites: Node.js 20+, pnpm 10+, Rust (stable), Tauri v2 prerequisites.
• Build Commands: git clone https://github.com/xiaolai/vmark.git, cd vmark, pnpm install, pnpm tauri dev (development), pnpm tauri build (production).
• Links: Documentation, Features Highlights, MCP Setup Guide, AI Development.

Highlighted Details

• AI-Native Integration: Supports MCP for Claude Desktop/Code, Codex CLI, Gemini CLI; includes AI Genies for inline assistance.
• Multi-Mode Editing: Offers WYSIWYG, Source Peek, and full Source editing views.
• Local-First Architecture: Ensures data privacy with no cloud sync, accounts, or analytics.
• Enhanced Text Formatting: Includes multi-cursor editing, Tab Escape for efficient typing, and 20+ rules for CJK text.
• Customization: Features 5 themes and over 122 customizable shortcuts.

Maintenance & Community

The project is developed entirely by AI under human supervision ("vibe-coded"). Contributions are welcomed exclusively through issues (bug reports, feature requests), as external Pull Requests (PRs) are not accepted. AI handles issue resolution with project context. For support or to report issues, use the provided issue links.

Licensing & Compatibility

The project is released under the ISC License, which is permissive and allows free use, copying, modification, and distribution, including for commercial purposes.

Limitations & Caveats

External code contributions via Pull Requests are not accepted, limiting community involvement in direct code development. While Windows and Linux builds are provided, they are considered best-effort, with macOS being the primary development and supported platform. The project's reliance on AI for development may present unique challenges for long-term code understanding and maintenance.