https://github.com/htmlpreview/htmlpreview.github.com

HTML Preview for GitHub Repositories
https://github.com/htmlpreview/htmlpreview.github.com

Last synced: 11 days ago
JSON representation

HTML Preview for GitHub Repositories

• Host: GitHub
• URL: https://github.com/htmlpreview/htmlpreview.github.com
• Owner: htmlpreview
• Created: 2012-09-02T03:57:02.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2024-05-30T08:52:15.000Z (5 months ago)
• Last Synced: 2024-08-01T08:16:19.704Z (3 months ago)
• Language: JavaScript
• Homepage: htmlpreview.github.com
• Size: 66.4 KB
• Stars: 1,513
• Watchers: 27
• Forks: 303
• Open Issues: 61
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• awesome-starred - htmlpreview/htmlpreview.github.com - HTML Preview for GitHub Repositories (others)

README

        
GitHub & BitBucket HTML Preview

-------------------------------

Many GitHub repositories don't use GitHub Pages to host their HTML files. **GitHub & BitBucket HTML Preview** allows you to render those files without cloning or downloading whole repositories. It is a client-side solution using a CORS proxy to fetch assets.

If you try to open raw version of any HTML, CSS or JS file in a web browser directly from GitHub, all you will see is a source code. GitHub forces them to use the "text/plain" content-type, so they cannot be interpreted. This script overrides it by using a CORS proxy.

## Usage

In order to use it, just prepend this fragment to the URL of any HTML file: **[https://htmlpreview.github.io/?](https://htmlpreview.github.io/?)** e.g.:

 - https://htmlpreview.github.io/?https://github.com/twbs/bootstrap/gh-pages/2.3.2/index.html

 - https://htmlpreview.github.io/?https://github.com/documentcloud/backbone/blob/master/examples/todos/index.html

What it does is: load HTML using CORS proxy, then process all links, frames, scripts and styles, and load each of them using CORS proxy, so they can be evaluated by the browser.

**GitHub & BitBucket HTML Preview** was tested under the latest Google Chrome and Mozilla Firefox.

## License

© 2019 Jerzy Głowacki under Apache License 2.0.