Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

gatsby-remark-embed-video

2.0.1 • Public • Published

gatsby-remark-embed-video

Embed a Youtube Video in your Markdown

Inspired by gatsby-remark-embed-youtube

Install

  1. Install plugin to your site:
npm i gatsby-remark-embed-video
 
yarn add gatsby-remark-embed-video
  1. Add following to your gatsby-config.js:
    plugins: [
      {
        resolve: "gatsby-transformer-remark",
        options: {
          plugins: [
          {
            resolve: "gatsby-remark-embed-video",
            options: {
              width: 800,
              ratio: 1.77, // Optional: Defaults to 16/9 = 1.77
              height: 400, // Optional: Overrides optional.ratio
              related: false, //Optional: Will remove related videos from the end of an embedded YouTube video.
              noIframeBorder: true, //Optional: Disable insertion of <style> border: 0
              urlOverrides: [
                {
                  id: 'youtube',
                  embedURL: (videoId) => `https://www.youtube-nocookie.com/embed/${videoId}`,
                }
              ] //Optional: Override URL of a service provider, e.g to enable youtube-nocookie support
            }
          }
          ]
        }
      },

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

plugins: [
  "gatsby-remark-embed-video",
  "gatsby-remark-responsive-iframe"
]

Note: you can style the videoIframe using .embedVideoIframe

  1. Restart gatsby.

Usage

Look at this Video:
 
`video: https://www.youtube.com/embed/2Xc9gXyf2G4`
`youtube: https://www.youtube.com/watch?v=2Xc9gXyf2G4`
`youtube: 2Xc9gXyf2G4`
 
`vimeo: https://vimeo.com/5299404`
`vimeo: 5299404`
 
`videoPress: https://videopress.com/v/kUJmAcSf`
`videoPress: kUJmAcSf`
 
`twitch: https://player.twitch.tv/?channel=dakotaz`
`twitch: https://player.twitch.tv/?autoplay=false&video=v273436948`
`twitch: 273436948`
`twitchLive: dakotaz`
 

License

MIT

Install

npm i gatsby-remark-embed-video

DownloadsWeekly Downloads

2,886

Version

2.0.1

License

MIT

Unpacked Size

29.7 kB

Total Files

20

Last publish

Collaborators

  • avatar