ZMark

A Modern, AI-Powered Markdown Editor & Local Knowledge Base

English | 简体中文

Features • Installation • Development • Tech Stack

ZMark is a local-first desktop application that combines a seamless Markdown editing experience with an intelligent, Retrieval-Augmented Generation (RAG) knowledge base. Built for speed and privacy, it serves as your personal second brain.

Features

Seamless Editing Experience

• WYSIWYG Markdown: A Notion-style, block-based editor powered by Tiptap. Supports drag-and-drop block reordering.
• Slash Commands & Bubble Menus: Quick content formatting using / commands or floating contextual menus.
• Interactive Frontmatter: Beautiful, built-in property panels for effortless metadata and tag management.
• Rich Content Support: Out-of-the-box support for code highlighting (lowlight), image management, text highlighting, and math equations (KaTeX).
• Interactive Graph View: Visualize connections between your documents using an interactive node graph.
• Real-time Collaboration: Built-in support for collaborative editing using Yjs and Hocuspocus.

Intelligent Knowledge Base (RAG)

• Local-First Architecture: Your data stays on your device. Powered by a high-performance SQLite local database (rusqlite).
• AI Integration: Deep integration with SiliconFlow API. Uses BAAI/bge-m3 for precise vector embeddings and Qwen/Qwen3-8B for fluid, streaming Q&A.
• Transparent Retrieval: Visualizes the RAG process, showing referenced documents and similarity scores alongside AI responses.
• Quick Capture: A global floating window for capturing fleeting thoughts instantly, supported by global shortcuts.

Beautifully Crafted UI

• Modern Design: Built with Tailwind CSS 4 and Shadcn UI for a sleek, responsive interface.
• Native Dark Mode: First-class dark mode support that respects your system preferences.

Installation

Download Pre-compiled Binaries

You can download the latest pre-compiled binaries for macOS, Windows, and Linux from our Releases page. These builds are automatically generated via GitHub Actions.

Build from Source

If you prefer to build ZMark from source:

Prerequisites

• Rust
• Node.js (v24 recommended as per CI)
• pnpm (v9.0.0+)

Steps

1. Clone the repository:

git clone https://github.com/zhoumowan/zmark.git
cd zmark

2. Install dependencies:

pnpm install

3. Build the application:

pnpm build

Development

To start the development server with Hot Module Replacement (HMR) and the Tauri window:

pnpm dev

Configuration

To unlock full capabilities after launching the app:

1. Navigate to Settings.
2. Enter your SiliconFlow API Key for AI features.
3. Configure Supabase Auth credentials if you want to use cloud synchronization and GitHub login features.

Tech Stack

• Frontend: React 19, Vite, Tailwind CSS 4, Shadcn UI
• Editor Engine: Tiptap, ProseMirror, Yjs
• State Management: Zustand
• Desktop/Backend: Tauri 2, Rust, SQLite (rusqlite)
• AI & Auth: SiliconFlow API, Supabase
• CI/CD: GitHub Actions, Semantic Release

License

This project is licensed under the MIT License - see the LICENSE file for details.