How GitHub renders a README, and what is different here
When you open a repository, GitHub shows the README from the default branch as GitHub Flavored Markdown: tables, task lists, footnotes, alert blocks, Mermaid diagrams and math, with raw HTML passed through an allow-list that strips scripts and styles. Relative paths such as docs/logo.png are resolved against the repository, and every heading gets an anchor you can link to.
This viewer asks GitHub's API for that same README, with one request per load, and renders it in your browser with the same rules where it can. The differences are real, so here they are:
- Code blocks are not syntax-coloured; GitHub colours them by language.
- Emoji shortcodes such as :tada:, @mentions and #123 issue references stay as plain text instead of becoming emoji or links.
- Relative links to other Markdown files open in the tinyMD Markdown Viewer; other relative links point to the raw file on raw.githubusercontent.com rather than GitHub's file page.
- Light and dark <picture> logos follow your device's colour setting, not the preview's dark toggle.
- Only Markdown READMEs render properly; a README.rst or README.org is shown as if it were Markdown.
- Files larger than 2 MB are not loaded.
Check a README before you open a pull request
A README that looks fine in your editor can still break on GitHub: an alert typed as > [!Note]: with a colon stays an ordinary quote, a table without its header separator row turns into a paragraph of pipes, and Markdown placed inside a <p align="center"> or <div> without a blank line around it shows up as literal ** and # characters.
- Paste the draft into the Paste README tab and read it in the GitHub styling, in light and in dark.
- Open the outline: missing or oddly nested headings show up there before a reviewer spots them.
- Click a few heading links to confirm the #anchors other pages link to still exist.
- After you push the branch, paste its folder or file link (github.com/owner/repo/tree/branch) to check that relative images resolve.
- Use Open in editor for bigger rewrites, or Export PDF to share a copy with someone outside GitHub.