Skip to content

Latest commit

 

History

History
43 lines (23 loc) · 1.73 KB

File metadata and controls

43 lines (23 loc) · 1.73 KB

oEmbed Spec

Build Status NPM version

This repo represents the current oEmbed spec as seen at http://oembed.com and any drafts, in the www directory.

It also contains configuration information (the registry) for oEmbed providers, as YAML files in the providers directory.

Consuming the provider registry

If you need to use the provider registry directly, you can install this package using NPM:

npm install https://github.com/iamcal/oembed

That will install the providers file into node_modules/oembed-providers/providers.json, where you can ingest it directly.

Development

The website (www/index.php) is rendered by PHP and uses the yaml extension to count the providers in the registry. The included Dockerfile provides a PHP runtime with that extension already set up, so you don't need to install anything locally.

Build the image once:

docker build -t oembed-site .

Then run it, mounting the repo so edits are picked up live:

docker run --rm -p 8000:8000 -v "$PWD":/var/www/html oembed-site

Open http://localhost:8000 to see the site. Editing www/index.php and refreshing the page is enough — no rebuild required.

Maintainers: Publishing to NPM