GitHub README preview

README Viewer: preview any GitHub README.md online

Type owner/repo or paste a GitHub link to read a project’s README with GitHub’s styling, working images, alert callouts and a clickable outline, without cloning anything. Drafting your own? Paste it in and check how it will look before you push.

Uses public data from GitHub. Not affiliated with GitHub.

Your browser fetches the README directly from GitHub. Nothing passes through tinyMD.

Try:

Read a README without cloning the repo

Enter a repository above, or pick one of the examples.

  • GitHub stylingLight or dark, with NOTE, TIP and WARNING alerts as callouts.
  • Images and links workRelative paths resolve to the repository, as on GitHub.
  • Clickable outlineEvery section of a long README, one tap away.

Writing a README instead?

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.

How to use GitHub README Viewer

  1. Type owner/repo (for example facebook/react) or paste a GitHub link into the field
  2. Click View README, or tap one of the example repositories
  3. Jump between sections with the outline, and switch the preview to dark with the moon button
  4. Copy the address bar to share the view, or open the Paste README tab to check a draft before you push

Why use tinyMD for GitHub README Viewer

  • Type owner/repo or paste a GitHub repository, file, folder or .git link to load its README
  • GitHub styling in light or dark, with NOTE, TIP, IMPORTANT, WARNING and CAUTION alerts shown as coloured callouts
  • Relative images and links resolve against the repository, including light and dark <picture> logos
  • Outline of every section: a sidebar on desktop, a collapsible list on phones, plus #heading links like GitHub's
  • Paste README tab for drafts, with Copy Markdown, Open in editor and Export PDF
  • Shareable ?repo= links; your browser fetches the README straight from GitHub, not through tinyMD

Frequently asked questions

How do I preview a README.md without pushing to GitHub?

Open the Paste README tab and paste your file; the preview uses GitHub's styling and updates as you type. Tables, task lists, alerts, Mermaid diagrams and math all render. Images with relative paths won't load until the file is in a repository, because there is nothing to resolve them against yet.

Can I view a private repository's README?

No. The page has no GitHub sign-in, so it can only read public repositories, and a private one comes back as not found. Copy the README from your local clone and paste it into the Paste README tab instead.

Does it render GitHub alerts, Mermaid diagrams and math?

Yes. > [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] and [!CAUTION] blocks become coloured callouts, ```mermaid code blocks become diagrams, and $…$ and $$…$$ math is rendered with KaTeX. Code blocks are not syntax-coloured, and emoji shortcodes such as :rocket: stay as plain text.

Why does it say GitHub's hourly limit was reached?

GitHub allows 60 API requests per hour from one IP address without a login, and each README you load here uses one. Wait for the hour to reset, or paste the README text into the Paste README tab.

Which links can I paste?

Any of owner/repo, a github.com repository link, a link to a file or folder inside a repository, a clone URL ending in .git, or package.json shorthand such as github:owner/repo. A folder link shows that folder's README, and a file link shows that Markdown file.

Is the repository or README sent to tinyMD?

No. Your browser requests the README directly from GitHub and renders it locally. The site's page analytics count that a README was opened and its size range, never the repository name or its text.

Can I share the README view with someone?

Yes. Once a README loads, the address bar holds ?repo=owner/repo, and clicking a heading link adds #section, so copying the address shares the same README at the same place.