Browse source code for this package on GitHub

gatsby-remark-images

Processes images in markdown so they can be used in the production build.

In the processing, it make images responsive by:

  • Adding an elastic container to hold the size of the image while it loads to avoid layout jumps.
  • Generating multiple versions 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.
  • Using 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-images

How to use

// In your gatsby-config.js
plugins: [
  {
    resolve: `gatsby-transformer-remark`,
    options: {
      plugins: [
        {
          resolve: `gatsby-remark-images`,
          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,
            // Remove the default behavior of adding a link to each
            // image.
            linkImagesToOriginal: true,
            // Analyze images' pixel density to make decisions about
            // target image size. This is what GitHub is doing when
            // embedding images in tickets. This is a useful setting
            // for documentation pages with a lot of screenshots.
            // It can have unintended side effects on high pixel
            // density artworks.
            //
            // Example: A screenshot made on a retina screen with a
            // resolution of 144 (e.g. Macbook) and a width of 100px,
            // will be rendered at 50px.
            //
            // Defaults to false.
            sizeByPixelDensity: false,
          },
        },
      ],
    },
  },
];

Was this helpful? edit this page on GitHub