A README you want to eyeball before the PR. GitHub, GitLab, and Notion each render extras we may not.
A README with a table you want to see before the review. This page renders Markdown in the tab. It is not GitHub’s exact pipeline.
Formatters for other languages sit next door. Diff two README versions on text diff. Entities that a CMS ate: HTML entities.
README before the PR
Tables and task lists are a GFM subset. GitHub, GitLab, and a wiki will disagree. Treat inline HTML as untrusted. Mermaid is not promised. The host preview is the source of truth after you push.
How to use it
- Paste Markdown.
- Glance at headings, lists, and links.
- Push and re-check on the host if you used vendor extras.
Honest limits
Not mermaid CI. Not a blog engine. Not XSS-safe by slogan.