README Viewer

Open any README.md and read it the way it was meant to look

Paste markdown below or use example: ,

Read READMEs without cloning anything

A README.md downloaded from a release, attached to a zip, or generated by a tool opens as raw text — headings as # marks, code and prose running together. Drop it here instead and read it fully rendered: formatted headings, highlighted code blocks, working task lists, and GitHub-style callouts.

This is useful when a README arrives outside GitHub: inside a release archive, attached to a ticket, produced by a generator, or copied from another repository. You can inspect installation commands, configuration examples, compatibility notes, and project structure without cloning the repository or opening a development workspace.

The viewer also handles the parts that basic text readers miss. Mermaid diagrams render inline, wide tables remain navigable, and long project documentation gets a table of contents. The result is a reading surface for the whole README rather than a partial approximation of it.

Three ways to open a README

  1. Drag & drop the README.md file onto the box above.
  2. Paste its contents and hit Render it →.
  3. From a terminal: add the one-line shell function from the homepage and run mvd README.md.

Renders what GitHub renders

READMEs use the full range of GitHub-flavored Markdown — this viewer keeps up.

GitHub-flavored Markdown

  • NOTE / TIP / IMPORTANT / WARNING / CAUTION callouts
  • Fenced code blocks with syntax highlighting
  • Tables, task lists, and strikethrough
  • Relative structure preserved for headings and anchors

Diagrams included

  • Mermaid architecture diagrams render inline
  • Fullscreen mode for dense diagrams

Built for long project docs

  • Auto table of contents from headings
  • Print-friendly layout and PDF export
  • Share the rendered README as a clean link
  • Responsive reading on desktop and mobile

Open a README now

FAQ

Can I view a README without cloning the repository?

Yes — open the README.md file directly, or paste its raw contents. No repository, no git, no setup.

Are GitHub callouts like [!NOTE] supported?

Yes. GitHub alert syntax renders as proper callout blocks, the same way GitHub shows them.

Does my README stay private?

Files you open render locally in your browser. Nothing is uploaded unless you choose to create a share link.

Is the README viewer free?

Yes — opening and reading README files is free and needs no account.

Can I inspect a README from a downloaded release?

Yes. Open the README.md from the extracted archive and it will render like a project document, including code blocks, tables, task lists, callouts, and supported diagrams.

Does this edit the README?

No. The page is optimized for opening and reading the rendered file. Use your normal editor for source changes, then reopen or paste the updated Markdown to verify the result.