Skip to content

marswaveai/ColaMD

Repository files navigation

ColaMD

The Agent Native Markdown Editor.

Real-time collaboration between humans and AI agents — see your agent's changes as they happen.

License: MIT GitHub release

Download | Why ColaMD | Features | Development | 中文


Why ColaMD?

AI agents are rewriting how we work. They edit files, generate docs, and produce reports — all in Markdown.

But how do you watch an agent work? You close the file. You reopen it. You wait.

ColaMD changes this. Open a .md file in ColaMD, let your agent edit it, and watch the content update in real-time — like pair programming with an AI. No refresh, no reload, no friction.

This is what Agent Native means: built from the ground up for a world where humans and agents collaborate on the same files.

Features

Agent Native

  • Live Agent Sync — When an AI agent (Claude Code, Cursor, Copilot, etc.) modifies your .md file, ColaMD detects the change and refreshes instantly. This is the core feature.
  • Agent Activity Indicator — A subtle dot in the titlebar shows you when an agent is writing: orange breathing pulse while active, green flash when done. You always know if your agent is working.
  • Cmd+Click Links — Click any link in the editor to open it in your browser.

Editor

  • True WYSIWYG — Type Markdown, see rich text. No split-pane preview.
  • Smart Line Breaks — Single newlines render as line breaks, matching how AI agents write Markdown.
  • Rich Text Copy — Copy content and paste into WeChat, email, or any rich text editor with formatting preserved.
  • Minimal by Design — No toolbar, no sidebar, no distractions. Just your content.

Themes & Export

  • Themes — 4 built-in themes + downloadable themes + import custom CSS.
  • Export — PDF and HTML.
  • Cross-platform — macOS, Windows, Linux.

Download

Check Releases for the latest builds.

Platform Format
macOS .dmg
Windows .exe
Linux .AppImage / .deb

How It Works

┌─────────────┐     writes     ┌──────────────┐
│  AI Agent   │ ──────────────▶│  .md file    │
│ (Claude,    │                │              │
│  Cursor...) │                └──────┬───────┘
└─────────────┘                       │
                              fs.watch detects
                                      │
                              ┌───────▼───────┐
                              │    ColaMD     │
                              │  auto-refresh │
                              │   ✨ live!    │
                              └───────────────┘
  1. Open any .md file in ColaMD
  2. Let your AI agent edit that file
  3. Watch the content update in real-time — the indicator dot pulses orange while the agent writes

No configuration needed. It just works.

What ColaMD Does NOT Do

ColaMD is intentionally simple:

  • No file manager or workspace
  • No cloud sync or collaboration
  • No AI features built in — it's a viewer/editor for AI-generated content
  • No plugin system

One thing, done well.

Custom Themes

ColaMD supports custom CSS themes. Download themes from the themes/ folder, or create your own and import via Theme > Import Theme.

Imported themes are saved to ~/.colamd/themes/ and persist across sessions.

Development

git clone https://github.com/marswaveai/colamd.git
cd colamd
npm install
npm run dev

Build

npm run dist:mac
npm run dist:win
npm run dist:linux

Tech Stack

  • Electron — Cross-platform desktop
  • Milkdown — WYSIWYG Markdown (ProseMirror-based)
  • TypeScript — Strict mode
  • electron-vite — Fast builds

Roadmap

ColaMD will evolve alongside the agent ecosystem:

  • v1.1 — Live file reload, file associations, drag & drop, themes
  • v1.2 — New icon
  • v1.3 — Agent activity indicator, Cmd+click links, rich text copy, smart line breaks, PDF/HTML export, theme persistence (current)
  • Future — Bidirectional sync, multi-file watching

License

MIT — Free forever.


Built by marswave.ai for the agent-native future.

About

The Agent Native Markdown Editor.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors