Markdown Editor

A web-based WYSIWYG markdown editor that works with your local files. Simply specify the root path of your documents to start editing.

Built with Milkdown and React CodeMirror for editing and displaying local markdown files.

Quick Start

🌐 Try it online

Download

1. Download from the latest release artifact.

Download the markdown-editor-macos.zip for MacOs, markdown-editor-windows.zip for Windows.

2. Unzip the file and run the binary file.

Tip

For MacOS, rignt click to open the App.

For windows, right click to run the executable as administrator.

Key Features

• WYSIWYG Editing: Rich markdown editing experience with Milkdown
• Dual Editor Mode: Switch between WYSIWYG and raw markdown (CodeMirror) with real-time sync
• File Operations: Create, rename, copy, move, and delete files and folders directly from the editor
• Git Integration: Commit, push, pull, and manage git changes if your document root is a git repository
• Search: Fast file name and content search across your documents based on ripgrep
• Image Management: Upload and manage images stored locally.

Development

Prerequisites

• Rust
• Node.js (v20+)
• pnpm

Setup

# Install dependencies
pnpm install

Run Development Server

The project consists of two main components:

• Rust Server (crates/server): Handles file operations, git sync, and search
• React Client (client): Web UI built with React and TypeScript

Start both components:

pnpm dev

This will automatically start the Rust server and React client with hot-reload.

Build

# Build both server and client
pnpm build

Release

Formal release:

pnpm release patch
pnpm release minor
pnpm release major

Pre-release:

pnpm release patch --alpha
pnpm release minor --beta
pnpm release major --rc