DEV Community

Cover image for I got tired of split-view Markdown previews, so I built ReadMeMaybe
Sachin Dahal
Sachin Dahal

Posted on

I got tired of split-view Markdown previews, so I built ReadMeMaybe

ReadMeMaybe in light and dark

I read a lot of Markdown in my editor: READMEs, docs, and lately plenty of implementation plans written by AI agents. The experience always felt a bit clunky:

  • The file opens as raw text, a wall of #, ** and |---|.
  • "Open Preview to the Side" gives you two panes and half a screen each.
  • Fixing one typo means hunting for the line in the raw file.
  • Depending on the extension, search, editing or themes are missing.

So I built ReadMeMaybe.

What it does

Install it, and every .md file opens as a clean, readable page. No commands, no settings.

  • Edit in place. Press ⌘E / Ctrl+E, click any block, and it turns into its Markdown right where it sits, with a small format bar. Press Esc and it renders again.
  • Find and outline. ⌘F searches the rendered page, and the outline panel jumps between sections.
  • Mermaid built in, plus GitHub alerts, footnotes, and task lists you can tick (they save to the file).
  • Five themes: Auto (follows your editor), Light, Dark, Sepia and Ocean, with sans/serif fonts, size and width.
  • Works in VS Code and Antigravity.

Editing a paragraph in place

How the editing works

It's a custom editor for .md files. The renderer remembers which source lines each block came from, so clicking a block swaps it for exactly those lines. Edits go back into the real document as small line-range changes, so the unsaved dot, undo, ⌘S and git all behave like they do in the text editor. If the file changes underneath you, for example when an agent rewrites it, your edit won't overwrite theirs, and the page updates in place.

Try it

It's free and MIT licensed. I'd love to hear what you think, and what bugs you about Markdown previews today.

Top comments (0)