One command, done
Run mdsync README.md. It opens in your browser. Headings, code blocks, tables, links — all rendered. Dark and light themes.
Open source CLI
You already write markdown.
Now it actually looks good.
Every dev has a folder full of .md files that look like plain text.
mdsync opens them in your browser — rendered, searchable, and editable —
without changing how you work. One command. No config.
Try it now
npx markdownsync README.md
The problem
Markdown is everywhere. Reading it raw is painful.
READMEs, docs folders, AI output, meeting notes — it's all markdown.
But opening a .md file means squinting at hashtags and backticks,
or copy-pasting into some preview tool. mdsync skips all that.
Point it at a file or folder, and it's rendered in your browser instantly.
Edit in the browser
Double-click any section. Make your changes. Hit save. The .md file on disk updates. No copy-paste loop between editor and preview.
Changes sync both ways
Edit in VS Code? The browser updates live. Edit in the browser? The file updates on disk. You never have to refresh.
Works with AI tools
Run mdsync mcp to let Claude, Cursor, or any MCP-compatible tool read and write your docs programmatically.
Use cases
If you have markdown files, you have a use for this.
Project docs
mdsync ./docs turns your docs folder into a browsable workspace. Search across files, click to open, edit inline.
Notes
mdsync ~/notes — if you keep notes in plain markdown, this is the fastest way to read and edit them.
AI output
AI agents dump markdown constantly. mdsync makes that output readable and lets you fix the parts that are wrong.
Docs sites
mdsync build ./docs --out ./site generates a static site from the same files. Deploy it anywhere. No build framework.
Open source, MIT license
No config file. No theme to pick. No plugins.
Install it, point it at your markdown, and it works. That's the whole pitch.