Skip to content
Branch: master
Find file History
DSchau chore(release): Publish
 - gatsby-codemods@1.0.10
 - gatsby-dev-cli@2.4.12
 - gatsby-image@2.0.34
 - gatsby-plugin-netlify-cms@3.0.16
 - gatsby-plugin-netlify@2.0.13
 - gatsby-plugin-postcss@2.0.7
 - gatsby-plugin-react-css-modules@2.0.9
 - gatsby-plugin-sharp@2.0.29
 - gatsby-remark-copy-linked-files@2.0.11
 - gatsby-remark-custom-blocks@2.0.7
 - gatsby-remark-graphviz@1.0.9
 - gatsby-remark-images-contentful@2.0.10
 - gatsby-remark-images@3.0.10
 - gatsby-remark-responsive-iframe@2.1.1
 - gatsby-source-contentful@2.0.39
 - gatsby-source-drupal@3.0.31
 - gatsby-source-filesystem@2.0.27
 - gatsby-source-graphql@2.0.15
 - gatsby-source-hacker-news@2.0.10
 - gatsby-source-lever@2.0.7
 - gatsby-source-medium@2.0.6
 - gatsby-source-mongodb@2.0.15
 - gatsby-source-shopify@2.0.21
 - gatsby-source-wordpress@3.0.47
 - gatsby-transformer-excel@2.1.10
 - gatsby-transformer-json@2.1.11
 - gatsby-transformer-react-docgen@3.0.7
 - gatsby-transformer-sqip@2.0.25
 - gatsby-transformer-xml@2.0.9
Latest commit b62816f Mar 15, 2019
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src fix(gatsby-remark-images): override all default styling with wrapperS… Mar 11, 2019
.babelrc feat(gatsby-remark-images): make images blur up (#7800) Nov 21, 2018
.gitignore
.npmignore
CHANGELOG.md
README.md
package.json chore(release): Publish Mar 15, 2019

README.md

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 gatsby-plugin-sharp

How to use

// In your gatsby-config.js
plugins: [
  `gatsby-plugin-sharp`,
  {
    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,
          },
        },
      ],
    },
  },
]

Options

Name Default Description
maxWidth 650 The maxWidth in pixels of the div where the markdown will be displayed. This value is used when deciding what the width of the various responsive thumbnails should be.
linkImagesToOriginal true Add a link to each image to the original image. Sometimes people want to see a full-sized version of an image e.g. to see extra detail on a part of the image and this is a convenient and common pattern for enabling this. Set this option to false to disable this behavior.
showCaptions false Add a caption to each image with the contents of the title attribute, when this is not empty. Set this option to true to enable this behavior.
sizeByPixelDensity false 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.
wrapperStyle Add custom styles to the div wrapping the responsive images. Use the syntax for the style attribute e.g. margin-bottom:10px; background: red; or a function returning a style string which receives the information about the image you can use to dynamically set styles based on the aspectRatio for example.
backgroundColor white Set the background color of the image to match the background image of your design.
quality 50 The quality level of the generated files.
withWebp false Additionally generate WebP versions alongside your chosen file format. They are added as a srcset with the appropriate mimetype and will be loaded in browsers that support the format. Pass true for default support, or an object of options to specifically override those for the WebP files. For example, pass { quality: 80 } to have the WebP images be at quality level 80.
tracedSVG false Use traced SVGs for placeholder images instead of the "blur up" effect. Pass true for traced SVGs with the default settings (seen here), or an object of options to override the defaults. For example, pass { color: "#F00", turnPolicy: "TURNPOLICY_MAJORITY" } to change the color of the trace to red and the turn policy to TURNPOLICY_MAJORITY. See node-potrace parameter documentation for a full listing and explanation of the available options.

dynamic wrapperStyle example

{
  resolve: `gatsby-remark-images`,
  options: {
    maxWidth: 800,
    wrapperStyle: fluidResult => `flex:${_.round(fluidResult.aspectRatio, 2)};`,
  },
}

Supported Formats

This plugin will support the following formats:

  • JPEG
  • PNG

Since it uses Sharp for image processing, this plugin will not support GIFs or SVGs. If you would like to render these file types with the image markdown syntax, add the gatsby-remark-copy-linked-files plugin. Do note with this it will load in the images, but won't use the features of Sharp such as the elastic container or the blur-up enhancements.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.