Preview a README.md exactly as readers will see it — without pushing to GitHub or cloning a repo. Drop the file in, or paste the markdown straight from your editor.
Check your README before you push
The classic loop — edit, commit, push, refresh GitHub, spot the broken table, repeat — wastes commits and time. Paste your README here (⌘V anywhere on this page) and you'll see GitHub-flavored rendering instantly: task lists, tables, footnotes, syntax-highlighted code blocks, and Mermaid diagrams.
GitHub-parity details most viewers miss
- Angle-bracket placeholders survive. Docs full of
<your-api-key>or<PR-number>render as text — they don't silently vanish as “unknown HTML tags”. - HTML comments stay hidden, like on GitHub — templates with
<!-- instructions -->read clean. - Task lists render as checkboxes, YAML front matter shows as a tidy table, and wide tables get room to breathe.
Reading READMEs, not just writing them
Downloaded a project ZIP? Reviewing docs offline? Drop any project's README (or its whole docs/ files, one at a time) into the viewer. Nothing uploads — the rendering runs in your browser, so private-repo files stay private.
Browse GitHub repos on your phone
The Read.md app goes one step further than this page: it opens repositories directly — public or private — and renders every .md in the file tree, on iPhone, iPad, Android, and Mac:
