Git Product home page Git Product logo

jekyll-retinamagick's Introduction

Automatic Image Resizing for Jekyll

This gem allows you to easily use MiniMagick to resize your images and automatically includes an @2x version for use with retina.js. This is a forked version of jekyll-minimagick modified specifically to add the generation of @2x versions of all of the image sizes. This is very much still a work in progress. If you would like to help out, make a fork and then submit a pull request.

Basic Setup

Requirements

You have to have imagemagick install on your machine. If you are using a mac and use homebrew, you can install imagemagick by runing brew install imagemagick.

Installation

Install the gem:

[sudo] gem install jekyll-retinamagick

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

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

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

# _config.yml
retinamagick:
	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. It will also generate a 200x200 thumbnail and add an @2x between the file name and the extention. It will also generate a 600x400 and 1200x800 image in a similar way and then place them in _site/img/photos/medium.

Bundler Setup

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

gem "jekyll-retinamagick"

to your gemfile and create the following plugin in your projects _plugins directory. I've called mine bundler.rb.

# _plugins/bundler.rb
require "rubygems"
require "bundler/setup"
require "jekyll-imagemagick"

jekyll-retinamagick's People

Contributors

anoesj avatar btobolaski avatar sheerun avatar tmbritton avatar zroger avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

tmbritton anoesj

jekyll-retinamagick's Issues

uninitialized class variable @@mtimes

Tried to build with this plugin enabled, getting:

jekyll 3.3.1 | Error:  uninitialized class variable @@mtimes in Jekyll::JekyllRetinamagick::GeneratedImageFile
Did you mean?  mtimes

Does this plugin still work?

@2x images seem to be upscaled versions of their smaller sized thumbnails

Hey!

First of all: I'm not good with Ruby, I guess I seriously just made a lucky guess with this.
I noticed that the 2x versions of images were really pixelated and ugly so I dived into your code and found out that changing this line:

@commands[:resize] = "#{Integer(width) * 2}x#{Integer(height) * 2}"

...into this:

@commands["resize"] = "#{Integer(width) * 2}x#{Integer(height) * 2}"

...fixes the problem and actually renders the 2x versions the way you would expect them to look.

Cheers,
Anoesj

Speed up builds

The changes for v0.0.2 caused the builds to slow down. This should be fixed while not regressing on the fixes in v0.0.2.

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

spec.license = 'MIT'
# or
spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.