README HTML

Show same-repository HTML documents inline in GitHub READMEs with a #html-preview link.

Read HTML documents directly inside GitHub READMEs. README HTML displays a static document below a marked link in a public GitHub repository. Keep reports, diagrams, and project overviews alongside your code, with no separate website to deploy. How it works 1. Save a self-contained HTML file in your public repository. 2. Add a link such as [View report](./docs/report.html#html-preview) in its own README paragraph. 3. Open the README with the extension enabled. The document appears below the link. Features - Inline CSS, SVG diagrams, CSS charts, and native expandable sections. - Multiple previews, collapse/expand, manual resizing, and retry on failure. - The original GitHub file link remains available to readers without the extension. Current limits Chrome 120+ and public repositories on github.com. Same-repository UTF-8 HTML files up to 1 MiB. JavaScript, external resources, private repositories, and GitHub Enterprise are not supported. Documents must include their styles and assets inline. Privacy No account, analytics, or third-party preview server. Public HTML is fetched directly from GitHub Raw without cookies or authentication credentials and processed in browser memory. GitHub receives these file requests. Scripts and external resources are blocked in the isolated document preview. Free and open source under the MIT license. This is an independent project, not affiliated with GitHub or Google. Demo and source: https://github.com/luty4ng/readme-html Support: https://github.com/luty4ng/readme-html/issues Privacy: https://github.com/luty4ng/readme-html/blob/main/PRIVACY.md