Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zroger committed Jul 8, 2011
1 parent cc31553 commit 94d1a0a
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
MiniMagick integration for Jekyll
=================================

This gem allows you to easily use MiniMagick to crop and resize images in your
Jekyll project, according to a preset defined in your config file.

Basic Setup
-----------
Install the gem:

[sudo] gem install jekyll-minimagick

In a plugin file within your Jekyll project's _plugins directory:

# _plugins/my-plugin.rb
require "jekyll-minimagick"

Define presets in your _config.yml file, like this:

# _config.yml
mini_magick:
thumbnail:
source: img/photos/original
destination: img/photos/thumbnail
resize: "100x100"
medium:
source: img/photos/original
destination: img/photos/medium
resize: "600x400"

This configuration will create a 100x100 thumbnail for each image in
_img/photos/original_ and put it in _\_site/img/photos/thumbnail_ and a 600x400
image in _\_site/img/photos/medium_.

Bundler Setup
-------------
Already using bundler to manage gems for your Jekyll project? Then just add

gem "jekyll-minimagick"

to your gemfile and create the following plugin in your projects _plugins
directory. I've called mine bundler.rb. This will automatically require all
of the gems specified in your Gemfile.

# _plugins/bundler.rb
require "rubygems"
require "bundler/setup"
Bundler.require(:default)

0 comments on commit 94d1a0a

Please sign in to comment.