The average enterprise on Netlify ships 140 times per week. Where does your team rank?

ContactSign Up
Community Plugin
View plugin on GitHub


Embed a Youtube Video in your Markdown

Inspired by gatsby-remark-embed-youtube


  1. Install plugin to your site:
npm i @joyfulelement/gatsby-remark-embed-video

yarn add @joyfulelement/gatsby-remark-embed-video
  1. Add following to your gatsby-config.js:
module.exports = {
  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
              loadingStrategy: 'lazy', //Optional: Enable support for lazy-load offscreen iframes. Default is disabled.
              urlOverrides: [
                  id: "youtube",
                  embedURL: videoId =>
              ], //Optional: Override URL of a service provider, e.g to enable youtube-nocookie support
              containerClass: "embedVideo-container", //Optional: Custom CSS class for iframe container, for multiple classes separate them by space

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:

plugins: [

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

  1. Restart gatsby.


# Look at this Video:

`youtube: 2Xc9gXyf2G4`

`vimeo: 5299404`

`videoPress: kUJmAcSf`

`twitch: 273436948`
`twitchLive: dakotaz`

Version 3 Added A11y support

video: [VideoTitle]( youtube: [Cool Youtube Video](



© 2023 Gatsby, Inc.