Skip to content
| Marketplace
Sign in
Visual Studio Code>Visualization>ReadMeMaybeNew to Visual Studio Code? Get it now.
ReadMeMaybe

ReadMeMaybe

Sachin Dahal

|
1 install
| (0) | Free
An easy Markdown preview and editor. Opens .md files rendered, edit right in the page, with Mermaid, search and themes. Zero setup.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

ReadMeMaybe logo

ReadMeMaybe

Hey, I just met you, and this is crazy…
but here's your Markdown, so read it, maybe? 📞

A beautiful Markdown preview and in-place editor for VS Code and Antigravity.
Install it. That's the setup. There is no step two.

The same document in the Light and Dark themes

The problem (a tragedy in six acts)

You open a README.md and…

  1. 😐 It's raw. A wall of #, ** and |---|---|. You wanted a document, not a ransom note.
  2. 🪟 "Open Preview to the Side." Congratulations, you now have two of everything and half a screen for each.
  3. ✏️ You want to fix one typo. The "editor" opens a split view of the raw file and wishes you luck finding the line.
  4. 🖱️ You select some text to copy it. Surprise! Another split view. Nobody asked for that.
  5. 🔍 You press ⌘F. Nothing happens. Rendered text is apparently classified.
  6. 🎨 You'd like a different theme. You get the one you get. Mermaid diagrams? That's another extension. Have fun.

The fix

ReadMeMaybe opens every .md file as a clean, readable page, automatically. No commands, no settings, no "Open Preview" dance.

You want to… You do…
Read Nothing. It's already rendered.
Edit Press ⌘E / Ctrl+E, click any block, type. Esc when done. It edits right where it sits.
Find ⌘F / Ctrl+F. Matches light up, even inside collapsed <details>.
Copy Select and copy. Nothing pops open. Code blocks have their own copy button.
Change the look Click Aa: Auto, Light, Dark, Sepia or Ocean, sans or serif, text size and width.
Get around Outline panel, heading anchors, and links that open other docs (even other.md#some-heading).
Focus Hide the toolbar with ⌃. It comes back when you want it.
See the raw text Click Open as plain text in the toolbar. Same tab, no split. Open in ReadMeMaybe brings you back.

A closer look

Editing a paragraph in place

Edit in place. Click a block and it turns into Markdown right where it is, with a small format bar.

A Mermaid flowchart, task list and code block

Diagrams, tasks and code. Mermaid is built in, checkboxes save to the file, and code is highlighted.

Search results and the outline panel

Find and outline. Search the rendered page and jump between sections.

The appearance panel

Make it yours. Five themes, two fonts, and adjustable size and width.

What's in the box

  • The Markdown you actually use. GitHub tables, task lists, alerts like > [!TIP], footnotes, emoji, front matter, syntax highlighting, HTML, and images relative to your file.
  • Mermaid diagrams. Flowcharts, sequence diagrams, pie charts and more, matched to your theme. A broken diagram shows Mermaid's error message instead of an empty box.
  • Edits that are real edits. Changes go straight into the file, so the unsaved dot, undo, ⌘S and git work as usual. There's ⌘B / ⌘I / ⌘K, Tab to indent, and Enter continues a list.
  • Live updates. If the file changes elsewhere (git, another editor, an AI agent writing a plan), the page refreshes in place.

Settings

All of these are also in the Aa panel.

Setting Default What it does
readMeMaybe.theme auto auto follows your editor theme, or pick light, dark, sepia, ocean
readMeMaybe.fontFamily sans sans or serif
readMeMaybe.fontSize 16 Base text size in px (12–26)
readMeMaybe.contentWidth normal narrow, normal, wide or full
readMeMaybe.startInEditMode false Open files ready to edit

FAQ

Can I get the plain text editor back? For one file, click Open as plain text in the toolbar. For all Markdown files, run ReadMeMaybe: Toggle Auto-Open for Markdown Files, and run it again whenever you want ReadMeMaybe back.

What about git diffs? They stay normal side-by-side text diffs.

Does it work in Antigravity? Yes. It's tested in VS Code 1.146 and Antigravity IDE 1.107, and installs from Open VSX.

Is it safe to open files I didn't write? Yes. Scripts in Markdown never run, HTML is sanitized, and links only open when you click them.

How to contribute

Bug reports, ideas and pull requests are all welcome.

  • Found a bug or have an idea? Open an issue. A small Markdown snippet that shows the problem helps a lot.

  • Want to send a fix? Clone the repo and start the dev preview:

    git clone https://github.com/sachin-dahal/read-me-maybe.git
    cd read-me-maybe
    npm install
    npm run dev   # live preview in your browser at http://localhost:5179
    

    Press F5 in VS Code to try your changes in a new window with the example files open. Run npm test before opening a pull request, and keep the promise in mind: users install it and it just works, with no extra setup.

License

MIT

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
  • Your Privacy Choices
  • Consumer Health Privacy
© 2026 Microsoft