gatsby-remark-embed-video-ext

Embed a Youtube Video in your Markdown with additional options

Inspired by gatsby-remark-embed-youtube

Install

1. Install plugin to your site:

1npm i gatsby-remark-embed-video-ext
2
3yarn add gatsby-remark-embed-video-ext

2. Add following to your gatsby-config.js:

1module.exports = {
2  plugins: [
3    {
4      resolve: "gatsby-transformer-remark",
5      options: {
6        plugins: [
7          {
8            resolve: "gatsby-remark-embed-video-ext",
9            options: {
10              width: 800,
11              ratio: 1.77, // Optional: Defaults to 16/9 = 1.77
12              height: 400, // Optional: Overrides optional.ratio
13              related: false, //Optional: Will remove related videos from the end of an embedded YouTube video.
14              noIframeBorder: true, //Optional: Disable insertion of <style> border: 0
15              loadingStrategy: 'lazy', //Optional: Enable support for lazy-load offscreen iframes. Default is disabled.
16              sandboxOpts: 'allow-same-origin allow-scripts allow-popups allow-presentation', // Optional: sandbox options
17              urlOverrides: [
18                {
19                  id: "youtube",
20                  embedURL: videoId =>
21                    `https://www.youtube-nocookie.com/embed/${videoId}`,
22                },
23              ], //Optional: Override URL of a service provider, e.g to enable youtube-nocookie support
24              containerClass: "embedVideo-container", //Optional: Custom CSS class for iframe container, for multiple classes separate them by space
25              iframeId: false, //Optional: if true, iframe's id will be set to what is provided after 'video:' (YouTube IFrame player API requires iframe id)
26            },
27          },
28        ],
29      },
30    },
31  ],
32};

Note: if you also rely on gatsby-remark-responsive-iframe, gatsby-remark-images, or gatsby-remark-prismjs, you have to define the embed-youtube plugin first:

1plugins: [
2  "gatsby-remark-embed-video-ext",
3  "gatsby-remark-responsive-iframe",
4  "gatsby-remark-prismjs",
5  "gatsby-remark-images"
6]

Note: you can style the videoIframe using .embedVideo-container or by specifying a custom class

1. Restart gatsby.

Usage

1# Look at this Video:
2
3`video: https://www.youtube.com/embed/2Xc9gXyf2G4`
4`youtube: https://www.youtube.com/watch?v=2Xc9gXyf2G4`
5`youtube: 2Xc9gXyf2G4`
6
7`vimeo: https://vimeo.com/5299404`
8`vimeo: 5299404`
9
10`videoPress: https://videopress.com/v/kUJmAcSf`
11`videoPress: kUJmAcSf`
12
13`twitch: https://player.twitch.tv/?channel=dakotaz`
14`twitch: https://player.twitch.tv/?autoplay=false&video=v273436948`
15`twitch: 273436948`
16`twitchLive: dakotaz`

Version 3.2.7

• Fixed - ERR_REQUIRE_ESM failure when using unist-util-visit>=3.0.0

Version 3

• Added A11y support

video: [VideoTitle](https://www.youtube.com/embed/2Xc9gXyf2G4) youtube: [Cool Youtube Video](https://www.youtube.com/watch?v=2Xc9gXyf2G4)

License

MIT