jekyll-webp/README.md

Changes from original

• Forked from https://github.com/Rohithzr/jekyll-webp-ext (branch extend)
• Version bump to 1.1.1
• Keep only x64 binaries
• Updated gemspec

WebP Generator for Jekyll (Extended)

WebP Image Generator for Jekyll Sites can automatically generate WebP images for all images on your static site and serve them when possible. View on rubygems.org.

This repo is an extended version of it's fork jekyll-webp

Additional Features

• Generate thumbnails in webp format
• Generate small images (.5x) in webp format
• Specifiy output sub directory for webp images

Additional Dependencies

• fastimage

Installation instructions

group :jekyll_plugins do
  gem 'jekyll-webp', git: 'https://github.com/Rohithzr/jekyll-webp-ext', branch: 'extend'
end

Original installation instructions

gem install jekyll-webp

The release includes all necessary files to run, including the WebP redistributable executable files.

Currently the release includes the v0.6.1 version of the WebP utilities for Windows, Linux and Mac OS X 10.9 (Mountain Lion). Other versions and releases can be downloaded directly from the Google page.

Add the gem to your Gemfile and to Jekyll's _config.yml then run jekyll serve again and you should see the generator run during site generation.

Configuration

The plugin can be configured in the site's _config.yml file by including the webp configuration element

############################################################
# Site configuration for the WebP Generator Plugin
# The values here represent the defaults if nothing is set
webp:
  enabled: true

  # The quality of the webp conversion 0 to 100 (where 100 is least lossy)
  quality: 75

  # List of directories containing images to optimize, nested directories will only be checked if `nested` is true
  # By default the generator will search for a folder called `/img` under the site root and process all jpg, png and tiff image files found there.
  img_dir: ["/img"]

  # Whether to search in nested directories or not
  nested: false

  # add ".gif" to the format list to generate webp for animated gifs as well
  formats: [".jpeg", ".jpg", ".png", ".tiff"]

  # File extensions for animated gif files
  gifs: [".gif"]

  # Set to true to always regenerate existing webp files
  regenerate: false

  # Local path to the WebP utilities to use (relative or absolute)
  # Omit or leave as nil to use the utilities shipped with the gem, override only to use your local install
  # Eg : "/usr/local/bin/cwebp"
  webp_path: nil

  # List of files or directories to exclude
  # e.g. custom or hand generated webp conversion files
  exclude: []

  # append '.webp' to filename after original extension rather than replacing it.
  # Default transforms `image.png` to `image.webp`, while changing to true transforms `image.png` to `image.png.webp`
  append_ext: false

  ##### Extended Features start
  # Use a different output subdirectory
  # e.g. value of "/optimized" will create files at "/source/optimized" instead of "/source"
  output_img_sub_dir: "/optimized" # default ""

  # Generate thumbnails
  thumbs: true

  # Thumbnails sub directory
  thumbs_dir: "/thumbs"

  # generate .5x images
  generate_50p: true

  ##### Extended Features end
############################################################

Simplest use: HTML

In case you don't have control over your webserver then using the <picture> element and specifying all image formats available is the best option. This way the browser will decide which format to use based on its own capabilities.

<picture>
  <source srcset="/path/to/image.webp" type="image/webp">
  <img src="/path/to/image.jpg" alt="">
</picture>

Advanced use: Webserver Configuration

If you can, then configuring your webserver to serve your new .webp files to clients that support the format is probably the least problematic approach. This way you don't need to make any changes to your HTML files as your webserver will automatically serve WebP images when the client supports them.

Below is an example for a .htaccess configuration section in an Apache web-server. It will redirect users to webp images whenever possible.

####################
# Attempt to redirect images to WebP if one exists
# and the client supports the file format
####################
# check if browser accepts webp
RewriteCond %{HTTP_ACCEPT} image/webp

# check if file is jpg or png
RewriteCond %{REQUEST_FILENAME} (.*)\.(jpe?g|png)$

# check if corresponding webp file exists image.png -> image.webp
RewriteCond %1\.webp -f

# serve up webp instead
RewriteRule (.+)\.(jpe?g|png)$ $1.webp [T=image/webp,E=accept:1]

AddType image/webp .webp

Depending on other configurations in your .htaccess file you might have to update your ExpiresByType, ExpiresDefault and Header set Cache-Control directives to include the webp format as well.