eleventy-plugin-embed-cloudinary

eleventy-plugin-embed-cloudinary

Write an image URL → get a responsive image.

Table of Contents

• What is this?
• Why?
• Installation
• Configuration
  • Required parameters
  • Options
  • Image version and image public ID

What is this?

This library is an Eleventy plugin that will let you write an image URL like this in your markdown...

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam vehicula, elit vel condimentum porta, purus.

https://res.cloudinary.com/YOUR_CLOUDINARY_CLOUD_NAME/image/upload/YOUR_IMAGE_VERSION/YOUR_IMAGE_PUBLIC_ID.png

Maecenas non velit nibh. Aenean eu justo et odio commodo ornare. In scelerisque sapien at.

...and it will transform the image URL into a responsive image, optimized for your website visitor's device and browser:

<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam vehicula, elit vel condimentum porta, purus.</p>

<img
  alt="title of your image, retrieved automatically from Cloudinary at build time"
  class="CSS class/es to apply to all all <img> elements generated by this plugin"
  src="URL of the image hosted on your Cloudinary Media Library"
  srcset="comma-separated URLs of images transformed by Cloudinary (see details below)"
  sizes="media condition + comma-separated source size values (see details below)"
  width="width of your image, retrieved automatically from Cloudinary at build time"
  height="height of your image, retrieved automatically from Cloudinary at build time"
  loading="whether the image should be loaded using native lazy loading or not"
/>

<p>Maecenas non velit nibh. Aenean eu justo et odio commodo ornare. In scelerisque sapien at.</p>

Why?

Image optimization is hard and involves all of these steps:

1. serving the best available image format (e.g. AVIF, WebP) supported by your website visitors' browser.
2. picking the best resolution for each device used by your website visitors (you need to consider screen quality, Device Pixel Ratio, etc).
3. defining appropriate caching policies for your images (see Caching best practices & max-age gotchas).
4. optimizing your images for SEO and accessibility.
5. loading images lazily, not eagerly.

Even if you are a master of all of these things, it is still a lot of work. An image CDN like Cloudinary will take care of steps 1-3 (format, resolution, caching policies), so it will likely save you a lot of time. You just need to upload your highest resolution image to your Cloudinary Media Library and add alt and title metadata for SEO and accessibility.

Installation

Install the plugin with your package manager of choice (npm, yarn, pnpm).

npm i -D eleventy-plugin-embed-cloudinary

Add this plugin to your Eleventy configuration file (usually .eleventy.js):

const embedCloudinary = require('eleventy-plugin-embed-cloudinary');

module.exports = function(eleventyConfig) {
  eleventyConfig.addPlugin(embedCloudinary, {
    apiKey: 'YOUR_CLOUDINARY_API_KEY',
    apiSecret: 'YOUR_CLOUDINARY_API_SECRET',
    cloudName: 'YOUR_CLOUDINARY_CLOUD_NAME'
  });
};

Your API key and API secret are not exposed in the generated HTML. They are used to fetch the images hosted on your Cloudinary Media Library when Eleventy builds your site.

:warning: Don't forget to set the Cloudinary API key, API secret and cloud name on your build server. For example, if your build runs on the Github CI, use GitHub secrets; if the build runs on Netlify, use Build environment variables.

Configuration

Required parameters

Parameter	Explanation
apiKey	Your Cloudinary API key.
apiSecret	Your Cloudinary API secret.
cloudName	Your Cloudinary cloud name.

Options

Option	Default	Explanation
cacheDirectory	.cache	Directory where the 11ty Cache (see eleventy-cache-assets) stores the responses from the Cloudinary API. It is strongly recommended that you add this folder to your .gitignore file.
cacheDuration	30m	How long a response stored in the 11ty Cache should be considered valid. For the syntax, see here.
classString	""	CSS class/es to apply to the generated <img> element.
shouldLazyLoad	true	Whether the generated <img> element should have the attribute loading="lazy" to instruct the browser to defer loading the image (browser support here).
shouldThrowOnMissingAlt	false	Whether this plugin should throw an error when fetching an image that does not have an alt attribute. See here how to add a Description (alt) to an image hosted on your Cloudinary Media Library.

Image version and image public ID

For each image URL you write in your markdown files, you will need to specify its public ID (it's the last part of the URL, without the file extension) and its version.

https://res.cloudinary.com/YOUR_CLOUDINARY_CLOUD_NAME/image/upload/YOUR_IMAGE_VERSION/YOUR_IMAGE_PUBLIC_ID.png

Changelog

<small>1.0.2 (2022-06-09)</small>

• chore: add comment in pre-push hook (ec12acc)
• chore: avoid creating docs with pre-push hook (b5dd56e)
• chore: cleanup (cf9e8f2)
• chore(docs): update TOC (c2e1528)
• docs: re-run api-extractor and typedoc (1a1a581)
• fix: trigger for semantic release, cleanup (75bb2d9)
• ci: configure semantic-release and improve docs (3d9e48b)
• Add manual trigger to run BundleWatch workflow (5242484)
• Add SonarCloud badge in README (e0d705b)
• Add SonarCloud Scan in CI workflow (95dcc09)
• Add workflow to generate a TOC in README (8231677)
• Add workflow to notify Telegram chat when CI workflow fails (3995043)
• Cleanup workflows (4deaf10)
• Create sonarcloud config (02406f4)
• Forgot runs-on in workflow (8210107)
• Generate docs with TypeDoc and API Extractor (eb793e3)
• Notify Telegram when CI job is canceled (358584c)
• Rename and update CI workflow (0578b0e)
• Rename BundleWatch workflow and cleanup (faffebd)
• Replace size-limit with bundlewatch (2982430)
• Try out some more workflows (e18148f)
• Update check-file-sizes.yml (9b44b54)
• Update check-file-sizes.yml (10e8d20)
• Update CI worflow (857630a)
• Update ci.yml (d6a293f)
• Update notification workflow (055e8a1)
• Update notification workflow (2620059)
• Update notification workflow (6e832b3)
• Update notification workflow (9809a51)
• Update README (38648e3)
• Update sonarcloud config (1829e00)
• Upload test coverage only once (ab0414d)

Changelog

All notable changes to this project will be documented in this file. Dates are displayed in UTC.

Generated by auto-changelog.