installation.md

Installation

How to setup jekyll-resize in to your project

Requirements

• GraphicsMagick
• Ruby
• Jekyll

Install system dependencies

• Install GraphicsMagick.
  • gist instructions.
• Install Ruby and Bundler (recommended) at the user level.
  • gist instructions.

Install project packages

Note that the install URL in step 2 points to this fork repo on GH and not to RubyGems. The original gem is available on RubyGems with gem 'jekyll-resize', but it only supports Jekyll 3, hence the reason this fork exists.

1. Recommended - add either Jekyll 3 or 4 as a project gem in Gemfile.

   source 'https://rubygems.org'
   
   gem "jekyll", "~> 4.0.1"

2. Add jekyll-resize to your project's Gemfile using a GitHub URL.

   group :jekyll_plugins do
     gem "jekyll-resize", git: "https://github.com/MichaelCurrin/jekyll-resize"
   end

3. Install your project's gems.

   $ bundle install

Note you do not have to enable a gem to your plugins list in the config if it appears in the plugins group as above.

Configure

The resized image output is saved to a temporary cache directory at build time.

This directory should be added to your git ignore file:

cache/