jekyll-cloudinary 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dbec5c1b1a5bb03b9efffa626baff6ed106250f
-  data.tar.gz: 5a339dfa2adcc3ae34e65ad18ecf9327f91c0651
+  metadata.gz: 7c5672ae22dc5b6878eec8a18a18067c6077bada
+  data.tar.gz: 56da655d0e834eb5b376735f78542baf3ca04c1a
 SHA512:
-  metadata.gz: e3d3624ccdb2e9a303b7f9f92447313512a9394b1fb59541debbfb243f708247d50431f79abbe604f68927b0ae8356e0e429f7e34fb6a68e9a8aef1066354bd4
-  data.tar.gz: 6289d30c0565b4418eac890326c3877cb298897bc08c0f62bdde7fb48d125c16e1e9afaefb434f675e9c6d1758adfa2e73bd40ec3aa83bcd12b9fe4c0fea4743
+  metadata.gz: 52e9e6b92110f32af7c9c872c51baf6ba36ba13f8c6dd25d06791bcca24553973e320b35ee14803ed3e34a872ab0af4d163728a9d981765121ef3e6716987a7f
+  data.tar.gz: 78e9de26eb34dd27f677048fba619d2fc94bf13c79c6c45fd89e422b73bb1dc8513df04ae333b077fc8d0b3cb13186dce6d3673380c922f81ce639c3cd8d3b4c

data/README.md

@@ -1,3 +1,91 @@
-# jekyll-cloudinary
+# Jekyll Cloudinary Liquid tag
 
-Liquid tag for Jekyll to use Cloudinary for optimized responsive posts images.
+`jekyll-cloudinary` is a [Jekyll](http://jekyllrb.com/) plugin adding a [Liquid](http://liquidmarkup.org) tag to ease the use of [Cloudinary](http://cloudinary.com/invites/lpov9zyyucivvxsnalc5/sgyyc0j14k6p0sbt51nw) for responsive images in your Markdown/[Kramdown](http://kramdown.gettalong.org/) posts.
+
+It builds the HTML for responsive images in the posts, using the `srcset` and `sizes` attributes for the `<img />` tag (see [the "varying size and density" section of this post by Jake Archibald](https://jakearchibald.com/2015/anatomy-of-responsive-images/#varying-size-and-density) if this is new for you). URLs in the `srcset` are cloudinary URLs that [fetch on-the-fly](http://cloudinary.com/features#fetch) the post's images and resizes them to several sizes.
+
+You are in full control of the number of generated images and their size, and the `sizes` attribute that helps the browser decide which image to download. See the complete configuration options for details.
+
+## Using Jekyll Cloudinary
+
+[Sign up for free on Cloudinary](http://cloudinary.com/invites/lpov9zyyucivvxsnalc5/sgyyc0j14k6p0sbt51nw). The free account should be enough for mosts blogs.
+
+Add `gem 'jekyll-cloudinary'` to your `Gemfile` and run `bundle update` to install the gem.
+
+Add `jekyll-cloudinary` to your `_config.yml` like the following:
+
+```yaml
+gems:
+  - jekyll-cloudinary
+```
+
+## Configuration
+
+### Mandatory settings
+
+Add `cloudinary` to your `_config.yml` and your Cloudinary "Cloud name" (find it in your [Cloudinary dashboard](https://cloudinary.com/console)):
+
+```yaml
+cloudinary:
+  cloud_name: <put here your Cloudinary "Cloud name">
+```
+
+### Optional global settings
+
+You can now define some global settings
+
+```yaml
+cloudinary:
+  …
+  verbose: true
+```
+
+#### `auto`
+
+#### `verbose`
+
+
+### Optional (but highly recommended) presets
+
+```yaml
+cloudinary:
+  …
+  presets:
+    default:
+      min_size: 320
+      max_size: 1600
+      steps: 5
+      sizes: "(min-width: 50rem) 50rem, 90vw"
+    onethird:
+      min_size: 110
+      max_size: 535
+      steps: 3
+      sizes: "(min-width: 50rem) 17rem, 30vw"
+      attributes:
+        class: onethird
+```
+
+#### `min_size`
+
+#### `max_size`
+
+#### `steps`
+
+#### `sizes`
+
+#### `attributes`
+
+## Usage
+
+This is the Liquid tag syntax:
+
+```Liquid
+{% cloudinary [preset] path/to/img.jpg [attr="value"] %}
+```
+
+## Examples
+
+```Liquid
+{% cloudinary image1.jpg alt="alternate" %}
+{% cloudinary onethird image2.jpg alt="other" title="yet another one" %}
+```

data/lib/jekyll/cloudinary/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Cloudinary
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/lib/jekyll/cloudinary.rb

@@ -1,28 +1,3 @@
-=begin
-  Liquid tag to use Cloudinary for optimized responsive posts images.
-  Usage:
-    {% cloudinary [preset] path/to/img.jpg [attr="value"] %}
-  Examples:
-    {% cloudinary image1.jpg alt="alternate" %}
-    {% cloudinary onethird image2.jpg alt="other" title="yet another one" %}
-
-  Configuration
-    In _config.yml:
-
-    cloudinary:
-      api_id: …
-      auto: true
-      verbose: true
-      presets:
-        default:
-          min_size: 320
-          max_size: 1600
-          steps: 5
-          sizes: "(min-width: 50rem) 50rem, 90vw"
-          attributes:
-            class: onethird
-
-=end
 module Jekyll
   module Cloudinary
 
@@ -148,12 +123,12 @@ module Jekyll
           if settings['verbose']
             puts "[Cloudinary] Natural width of source image '#{File.basename(image_src)}' (#{natural_width}px) in #{context['page'].path} not enough for creating any srcset version"
           end
-          srcset << "http://res.cloudinary.com/#{settings['api_id']}/image/fetch/q_auto,f_auto/#{image_url} #{natural_width}w"
+          srcset << "http://res.cloudinary.com/#{settings['cloud_name']}/image/fetch/q_auto,f_auto/#{image_url} #{natural_width}w"
         else
           (0..steps).each do |factor|
             width = min_width + factor * step_width
             if width <= natural_width
-              srcset << "http://res.cloudinary.com/#{settings['api_id']}/image/fetch/c_scale,w_#{width},q_auto,f_auto/#{image_url} #{width}w"
+              srcset << "http://res.cloudinary.com/#{settings['cloud_name']}/image/fetch/c_scale,w_#{width},q_auto,f_auto/#{image_url} #{width}w"
             else
               if settings['verbose']
                 puts "[Cloudinary] Natural width of source image '#{File.basename(image_src)}' (#{natural_width}px) in #{context['page'].path} not enough for creating #{width}px version"

metadata

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