GitHub README preview
Paste your README, drop the file, or load a GitHub link, and see it rendered the way GitHub shows it: callouts, task lists, tables, footnotes, Mermaid diagrams and math. Nothing leaves your browser, so it is safe for private drafts.
Check your README before it goes live
Pushing a README just to see how it looks is slow, and mistakes show up on your repository page. This preview renders GitHub Flavored Markdown locally: > [!NOTE] callouts, - [x] task lists, tables with alignment, footnotes, syntax-highlighted code, mermaid diagrams and $math$. Badges and images load from their own URLs, and when you open a file from GitHub its relative image paths are resolved against the repository.
Things GitHub treats differently
- HTML comments are hidden, and only a safe subset of HTML is allowed. Scripts, iframes and inline styles are removed here too.
- Relative links such as
docs/guide.mdonly work once the file is in the repository. - Heading anchors use GitHub's rules: lower case, punctuation removed, spaces turned into hyphens.
Frequently asked questions
Is this the exact GitHub renderer?
It is a very close match for GitHub Flavored Markdown. GitHub-specific features that need your repository, such as issue references and @mentions, are not resolved.
Can I preview a README that is already on GitHub?
Yes. Paste the repository or file link into the link box and press Load.
Can I keep editing after the preview?
Use Edit in editor to continue in the visual editor, which writes clean Markdown back out.