jekyll-cloudinary 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccd0b8fa58e43ef68c0f5abb5b54974b6c5e7fc0
-  data.tar.gz: bfc0d0d82dfd31822b0ff9d18aa4495167c620ca
+  metadata.gz: f89661284c40115e8a2eb8bb429141d760f5255b
+  data.tar.gz: b154e81a2d9b3fe2a22083d9d3a2b9cd035da01d
 SHA512:
-  metadata.gz: 9d7e398b4644f245a19c777a73a86bd15d604e5739e7e30dc92c3dd0ca6362fdb1be88314862bacc9ba31401217f5e1caf2e2581399f939a6aa77b849c0d89ee
-  data.tar.gz: 273a2a4eb61ff108b6713b18c8b94b454cfc96f9eafb4be2a110cad35d9ccd227cf201eafddea482ec5f2ed145ea4eee91b5e90d8cdccded194a174ab8f2e9ee
+  metadata.gz: 227e844f37540fa5d33b88b0b83cfaeb2cf2e92b5752a0cd70b907d2f8ee3f23133851dbf7f148634cf8c1b0782d56bdc4a471655c1deef78d6d1e105789d240
+  data.tar.gz: 980cc9a535c8a6508831ac5c9ee70ad33eb2bf49f0b1ad567e67c9530704e5054e195df39e2c6d4e18acfa7bc6ae9ee2c3898d15c8cc77f8b28a1959863ad53e

data/README.md

@@ -12,9 +12,9 @@ Here is the general syntax of this Liquid tag:
 {% cloudinary [preset] path/to/img.jpg [attr="value"] %}
 ```
 
-## Using Jekyll Cloudinary
+## Installation
 
-[Sign up for free on Cloudinary](http://cloudinary.com/invites/lpov9zyyucivvxsnalc5/sgyyc0j14k6p0sbt51nw). The free account should be enough for mosts blogs.
+[Sign up for free on Cloudinary](http://cloudinary.com/invites/lpov9zyyucivvxsnalc5/sgyyc0j14k6p0sbt51nw). The free account should be enough for most blogs.
 
 Add `gem 'jekyll-cloudinary'` to your `Gemfile` and run `bundle update` to install the gem.
 
@@ -46,8 +46,19 @@ cloudinary:
   verbose: true
 ```
 
-#### `verbose`
+#### `verbose` (default: `false`)
 
+When set to `true`, this setting will show messages in the console when something goes wrong, such as:
+
+```
+[Cloudinary] Couldn't find this image to check its width: /path/to/jekyll/_site/assets/img.jpg
+```
+
+or
+
+```
+[Cloudinary] Natural width of source image 'img.jpg' (720px) in _posts/2016-06-09-post.md not enough for creating 1600px version
+```
 
 ### Optional (but highly recommended) presets
 
@@ -80,10 +91,13 @@ To get this HTML:
 
 
 
+There is a true default default preset, but you're strongly encouraged to define your own default preset.
 
 #### Additional presets
 
-You can add other presets if you need several image sizes in your posts, here is an example for images that take only one third of the post width:
+You can add other presets if you need several image sizes in your posts.
+
+Here is an example for images that take only one third of the post width:
 
 ```yaml
 cloudinary:
@@ -96,19 +110,54 @@ cloudinary:
       steps: 3
       sizes: "(min-width: 50rem) 17rem, 30vw"
       attributes:
-        class: onethird
+        class: "one3rd"
+```
+
+To use this additional preset, you will have to write this in your Markdown post:
+
+```liquid
+{% cloudinary onethird /assets/img.jpg %}
 ```
 
-#### `min_size`
+The generated element will also get a `class="one3rd"` that can be useful for example with this CSS:
+
+```css
+.one3rd {
+  max-width: 33%;
+  float: right;
+  margin: 0 0 1em 1em;
+}
+```
+
+### Detailed preset settings
+
+#### `figure` (default: `auto`)
+
+This setting lets you decide what to do when there is a `caption` attribute in the Cloudinary Liquid tag.
+
+The value can be:
+
+- `auto` (default): will generate a `<figure>` and `<figcaption>` only if there's a caption
+- `never`: will always generate a `<img>`, losing the caption
+- `always`: will always generate a `<figure>` and `<figcaption>`, even if there's no `caption` attribute
+
+If a `<figure>` is generated and there are attributes in the Liquid tag, they are added to the `<img>` if they are `alt` or `title`, or to the `<figure>`.
+
+#### `min_size` (default: `320`)
+
+#### `max_size` (default: `1200`)
+
+#### `steps` (default: `5`)
 
-#### `max_size`
+#### `sizes` (default: `"100vw"`)
 
-#### `steps`
+#### `attributes` (default: none)
 
-#### `sizes`
+Attributes are added without transformation to the generated element.
 
-#### `attributes`
+You can obviously define the `alt` attribute, mandatory for accessibility, but you can also set a `title`, a `class`, `aria-*` attributes for enhanced accessibility, or even `data-*` attributes you would like to use later with CSS or JavaScript.
 
+The `caption` attribute is the only one that can act differently, depending on the `figure` setting.
 
 ## Examples
 

data/lib/jekyll/cloudinary/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Cloudinary
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

data/lib/jekyll/cloudinary.rb

@@ -64,7 +64,7 @@ module Jekyll
         else
           natural_width = 100000
           if settings['verbose']
-            puts "\n[Cloudinary] 'Couldn\'t find this image to check its width: #{image_path}"
+            puts "\n[Cloudinary] Couldn't find this image to check its width: #{image_path}"
           end
         end
 
@@ -145,8 +145,8 @@ module Jekyll
         end
         srcset_string = srcset.join(",\n")
 
-        # preset['caption'] can be 'never', 'auto' or 'always'
-        if (caption || preset['caption'] == 'always') && preset['caption'] != 'never'
+        # preset['figure'] can be 'never', 'auto' or 'always'
+        if (caption || preset['figure'] == 'always') && preset['figure'] != 'never'
           "\n<figure #{attr_string}>\n<img src=\"#{image_url}\" srcset=\"#{srcset_string}\" sizes=\"#{sizes}\" #{img_attr} />\n<figcaption>#{caption}</figcaption>\n</figure>\n"
         else
           "<img src=\"#{image_url}\" srcset=\"#{srcset_string}\" sizes=\"#{sizes}\" #{attr_string} #{img_attr} />"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-cloudinary
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Nicolas Hoizey