https://github.com/1cgonza/gitbook-plugin-iframely
Gitbook plugin for getting any video or iframe card supported by iframely.
https://github.com/1cgonza/gitbook-plugin-iframely
gitbook-plugin iframes video
Last synced: 2 months ago
JSON representation
Gitbook plugin for getting any video or iframe card supported by iframely.
- Host: GitHub
- URL: https://github.com/1cgonza/gitbook-plugin-iframely
- Owner: 1cgonza
- Created: 2016-12-30T21:12:43.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-06T15:24:25.000Z (about 8 years ago)
- Last Synced: 2025-03-06T16:08:35.387Z (3 months ago)
- Topics: gitbook-plugin, iframes, video
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gitbook plugin iframely
Get any video or iframe card supported by [iframely](https://iframely.com). (Vimeo, YouTube, Facebook, Twitter, Instagram, etc)
*If you prefer an option without the need for an API key or depending on creating an account, you can try [gitbook-plugin-noembed](https://github.com/1cgonza/gitbook-plugin-noembed). It has less supported sites than iframely but still has all the popular ones and more.*
## Installation
Add "iframely" to your plugins in `book.json`.
```js
{
"plugins": ["iframely"]
}
```
## API Key (Required)
You need an API key from [iframely](https://iframely.com) (FREE or paid).
The free one can get you started and should work for most cases.
Once you have the key, add it to your `environment variable` or `book.json` when executing gitbook-cli.
If both `environment variable` and `book.json` are assigned, it will be prior to use values from `environment variable`.
```sh
> IFRAMELY_APIKEY=YOUR_IFRAMELY_APIKEY gitbook build
# or
> IFRAMELY_APIKEY=YOUR_IFRAMELY_APIKEY gitbook serve
```
```js
{
"pluginsConfig": {
"iframely": {
"apiKey": "YOUR_API_KEY"
}
}
}
```
## Usage
- You can use two filters: `iframely` or `video`. *(At the moment they both do exactly the same)*
- Make sure you wrap your URL around single or double quotes.
```md
{{ 'https://vimeo.com/31942602' | iframely }}
or
{{ 'https://vimeo.com/31942602' | video }}
```