https://github.com/queen-raae/gatsby-source-youtube-oembed
Source YouTube information without an API key using the oEmbed endpoint
https://github.com/queen-raae/gatsby-source-youtube-oembed
Last synced: about 2 months ago
JSON representation
Source YouTube information without an API key using the oEmbed endpoint
- Host: GitHub
- URL: https://github.com/queen-raae/gatsby-source-youtube-oembed
- Owner: queen-raae
- Created: 2022-02-03T18:18:19.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-08T10:18:45.000Z (over 1 year ago)
- Last Synced: 2025-03-25T02:01:39.513Z (2 months ago)
- Language: JavaScript
- Size: 372 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# @raae/gatsby-source-youtube-oembed
_Source YouTube information without an API key using the oEmbed endpoint 📺_
Â
## A message or two from Queen Raae 👑
### 1-on-1 Emergency Gatsby Call
Are you stuck on a reef in the sharky waters around the Gatsby islands? Check out [1-on-1 Emergency Gatsby Call](https://queen.raae.codes/gatsby-emergency/?utm_source=readme&utm_campaign=source-youtube-oembed) with Queen Raae to get friendly advice you can put into action immediately from a seasoned Gatsby developer.
### Stay updated and get the most out of Gatsby
Learn how to get the most out of Gatsby and **stay updated** on the plugin by [subscribing](https://queen.raae.codes/emails/?utm_source=readme&utm_campaign=source-youtube-oembed) to daily emails from Queen Raae and Cap'n Ola.
Â
## How to install
`npm install @raae/gatsby-source-youtube-oembed`
or
`yarn add @raae/gatsby-source-youtube-oembed`
## How to use
```
module.exports = {
plugins: [
`@raae/gatsby-source-youtube-oembed`
],
}
```
## Plugin Options
### YouTube Ids
Add the YouTube ids for the videos you would like to source!
**Type:** An array of YouTube ids
**Example:** `["Bk1jonYPFD4", "TzJfepDjpzM"]`
**Default:** `[]`
```
// gatsby.config.js
module.exports = {
plugins: [
{
resolve: "@raae/gatsby-source-youtube-oembed",
options: {
youTubeIds: ["Bk1jonYPFD4", "TzJfepDjpzM"],
},
},
],
};
```
### Refresh Interval
Time to wait between fetching fresh oEmbed data.
**Type:** Time in milliseconds
**Example:** `60000`
**Default(dev):** `60000 * 5` (5 minutes)
**Default(prod):** `0`
```
// gatsby.config.js
module.exports = {
plugins: [
{
resolve: "@raae/gatsby-source-youtube-oembed",
options: {
refreshInterval: 60000,
},
},
],
};
```
## Questions, Feedback and Suggestions
If you have any questions, feedback or suggestions head on over to [discussions](https://github.com/queen-raae/gatsby-source-youtube-oembed/discussions).
## Found a bug?
If you find a bug please open an [issue](https://github.com/queen-raae/gatsby-source-youtube-oembed/issues) and/or create a pull request to fix it.