1.4.1 • Published 5 months ago

gatsby-remark-cloudinary-images v1.4.1

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

gatsby-remark-cloudinary-images

Responsive cloudinary images in markdown.

Based on gatsby-remark-images

This plugin process cloudinary images in markdown using gatsby-transformer-cloudinary's API and generate responsive images like gatsby-remark-images. With this plugin you do not need to download your images when building.

NOTE: the images need to be already on cloudinary and referenced in markdown like [img](https://res.cloudinary.com/...)

Install

yarn add gatsby-remark-cloudinary-images

#min version required: @3.0.0
yarn upgrade gatsby-transformer-cloudinary

Configure

In gatsby-config.js :

module.exports = {
  plugins: [
    // ...
    {
      resolve: `gatsby-transformer-remark`,
      options: {
        plugins: [
        // ...
          {
            resolve:`gatsby-remark-cloudinary-images`,
            options: {
              cloudName: process.env.CLOUDINARY_CLOUD_NAME,
              // options
            },
          },
          {
            resolve:`gatsby-remark-images/`,
            options: {
              // ...
            },
          },
        ]
      },
    },
  ],
}

Options

Required options

  • cloudName: Cloud name of your Cloudinary account

Options from gatsby-remark-images

  • showCaptions (default: false)
  • markdownCaptions (default: false)
  • linkImagesToOriginal (default: true)
  • disableBGImage (default: false)
  • loading (default: 'lazy')
  • decoding (default: 'async')
  • wrapperStyle (default: )

See the original documentation for details about each option.

Options from gatsby-plugin-image

  • placeholder : only accept blurred and tracedSVG
  • formats (default: ['auto', 'webp'])
  • placeholderUrl
  • width
  • height
  • sizes
  • fit
  • breakpoints (default: [750, 1080, 1366, 1920])
  • backgroundColor (default: 'white')
  • aspectRatio

See the original documentation for details about each option.