Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

gatsby-remark-responsive-image

Make images in markdown responsive by:

  • Adding an elastic container to hold the size of the image while it loads to avoid layout jumps.
  • Generating multiple verions of images at different widths and sets the srcset and sizes of the img element so regardless of the width of the device, the correct image is downloaded.
  • Useing the “blur up” technique popularized by Medium

and Facebook where a small 20px wide version of the image is shown as a placeholder until the actual image is downloaded.

Install

npm install --save gatsby-remark-responsive-image

How to use

// In your gatsby-config.js
plugins: [
  {
    resolve: `gatsby-transformer-remark`,
    options: {
      plugins: [
        {
          resolve: `gatsby-remark-responsive-image`,
          options: {
            // It's important to specify the maxWidth (in pixels) of
            // the content container as this plugin uses this as the
            // base for generating different widths of each image.
            maxWidth: 590,
          },
        },
      ]
    }
  }
]
© 2023 Gatsby, Inc.