Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
README.md
index.js
retinajs.js

README.md

Plugins

RetinaJS

This plugins allows to "auto-retinize" an uploaded image using Cloudinary for RetinaJS support.

If your Ghost theme displays post/page images with a predefined width of 600px and you upload an image of 1800px width, the plugin will automatically generate the RetinaJS image variants of your image:

  • image.jpg
  • image@2x.jpg
  • image@3x.jpg

If you wish to integrate RetinaJS on your Ghost blog, read this blog article.

Features

  • Uses the parent upload and fetch Cloudinary options
  • Could generate up to Retina 5K (@5x) image variants (Cloudinary limitation)
  • Only generate available variants off the image (no scale up)
  • Appends a tag to each created image variant (e.g., dpr2 for @2x variant)
  • Fire&Forget support
  • Excellent test coverage (100% as I write this)

Caveat

It will generate Retina image variants for all images, including banners, author profile images and so on. Unfortunately, Ghost does not provide a contextualized storage adapter instance so for now, it's not possible to tell the adapter the purpose of the image.

Configuration

In order to activate and configure the plugin, you need to add the rjs property in the storage configuration:

{
    "storage": {
        "active": "ghost-storage-cloudinary",
        "ghost-storage-cloudinary": {
            "auth": {
                "cloud_name": "",
                "api_key": "",
                "api_secret": ""
            },
            "upload": {},
            "fetch": {},
            "rjs": {
                "baseWidth": 960,
                "fireForget": true
            }
        }
    }
}

Property baseWidth

  • Required
  • Is an integer or parseable number
  • Value must be >=1

It should match the blog post/page image predefined width of your theme: if your theme displays images with a width of 800px, this property value must be 800.
The plugin will compute the available variants for your image off this number.

Property fireForget

  • Optional, defaulted to false
  • Should be truthy or falsy

When truthy, the plugin will upload the first variant and return its URL while it will continue to create the subsequent variants in the background. This is useful when the RetinaJS is a nice-to-have asset to your blog.

Gotchas:

  • If the first variant creation fails, an error will be returned and other variants will be discarded
  • Each subsequent variant creation process is isolated and asynchronous
  • When a subsequent variant creation error occurs, the error is logged then discarded
  • It won't be much faster since the plugin won't upload the image for every variants: it reuses the first variant URL to generate subsequent variants

When falsy (default behavior), the plugin will wait for all variants to be successfully created to return the image URL.