VMware-Photon-OS/docs/node_modules/gitbook-plugin-noembed
Vidya Vasudevan 486812b712 baselining documentation for 3.0
Change-Id: I254b0fd1a36424e3caea7feb82b1dc3651a60b96
Reviewed-on: http://photon-jenkins.eng.vmware.com:8082/6099
Reviewed-by: Stuart Clements <sclements@vmware.com>
Tested-by: Stuart Clements <sclements@vmware.com>
2018-11-05 00:29:37 -08:00
..
assets baselining documentation for 3.0 2018-11-05 00:29:37 -08:00
.npmignore baselining documentation for 3.0 2018-11-05 00:29:37 -08:00
README.md baselining documentation for 3.0 2018-11-05 00:29:37 -08:00
index.js baselining documentation for 3.0 2018-11-05 00:29:37 -08:00
package.json baselining documentation for 3.0 2018-11-05 00:29:37 -08:00

README.md

Gitbook plugin Noembed

Get any video or iframe card supported by Noembed. (Vimeo, YouTube, Facebook, Twitter, Instagram, etc)

If the sites you need to embed are not supported by Noembed, you can try gitbook-plugin-iframely. They claim to support 1,800+ sites but you need at least a free account to get an API key.

Installation

Add "noembed" to your plugins in book.json.

{
  "plugins": ["noembed"]
}

Usage

  • You can use two filters: noembed or video. (At the moment they both do exactly the same)
  • Make sure you wrap your URL around single or double quotes.
{{ 'https://vimeo.com/31942602' | noembed }}

or

{{ 'https://vimeo.com/31942602' | video }}