E
by Elena
GitHub

Read-first markdown editing

A CLI-driven editor that opens in your browser. Real-time sync, Mermaid diagrams, light & dark themes.

View on GitHub
Screenshot placeholder

Edit markdown with live preview

Switch between Edit and Preview tabs. Your changes auto-save after 1 second of inactivity. External file changes sync in real-time via WebSocket.

Built with Python & FastAPI on the backend, vanilla JavaScript on the frontend. No dependencies bloatβ€”just what you need.

Install in seconds

Works with Python 3.11+

With UV (recommended)
uv tool install markdown-os
With PIP
pip install markdown-os

Then open a markdown file:

markdown-os open ./notes.md

Built for developers

⚑

Real-time sync

Edit from your terminal, watch changes appear instantly. WebSocket notifications for external file modifications.

πŸ“Š

Mermaid diagrams

Embed flowcharts, sequence diagrams, and more. Rendered live as you type. Switch between light & dark themes effortlessly.

πŸ”’

File locking

POSIX file locks prevent conflicts. Auto-save after 1 second. Conflict detection with merge UI.

🎨

Syntax highlighting

Code blocks render with full syntax highlighting. Copy button on every code block for quick access.

πŸ“–

Auto-generated TOC

Table of contents builds itself from headings. Smooth scrolling for instant navigation.

🌐

CLI-first workflow

Open directly from your terminal. No GUI app. No registration. No friction. Pure markdown editing.

Write more. Think clearer.

Get Started on GitHub