https://github.com/robin-drexler/amp-gh-gist-proxy
embed github gists in amp-iframes
https://github.com/robin-drexler/amp-gh-gist-proxy
amp amp-iframe github-gist proxy
Last synced: 12 months ago
JSON representation
embed github gists in amp-iframes
- Host: GitHub
- URL: https://github.com/robin-drexler/amp-gh-gist-proxy
- Owner: robin-drexler
- Created: 2017-01-23T08:56:01.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-23T14:55:45.000Z (over 9 years ago)
- Last Synced: 2025-06-05T16:47:10.110Z (12 months ago)
- Topics: amp, amp-iframe, github-gist, proxy
- Language: JavaScript
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# amp-gh-gist-proxy
Embed github gists in amp-iframes
## What
[amp](https://www.ampproject.org/) does not permit to embed external script files.
Therefore it's not easily possible to embed [github gists](https://gist.github.com/).
amp allows you to embed iframes, though. Due to the nature of iframes however, amp is not able to figure out the size of an iframe automatically.
This is where the proxy comes into play. It'll embed the gist content and tell amp about the height.
## Installation
Clone this repo. There is no npm package (yet).
## Usage
There is no hosted service yet, in order to use it you'd need to host it yourself.
### Starting the service
```cli
$ npm start -- 8080 # 8080 is the port the server will listen to
```
### Using the proxy
```cli
curl https://yourproxydomain.com/?url=https://gist.github.com/robin-drexler/d4d167f1aa0bd94094e2
```
### amp iframe example
```html
```
### Real world example
See it in use here: [https://www.robin-drexler.com/2015/07/07/overriding-default-browser-shortcuts/](https://www.robin-drexler.com/2015/07/07/overriding-default-browser-shortcuts/)