Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

metalsmith-picset-generate

0.0.2 • Public • Published

Generates image sets for use with metalsmith-picset-handlebars-helper to give browsers choice

Example use

Add to your pipeline like

npm i metalsmith-picset-generate --save
const picsetGenerate = require(metalsmith-picset-generate)
Metalsmith(__dirname)
    ...
    .use(picsetGenerate())
    ...

Under your source folder place an image /img/picset/picture_400,200,100w.jpg

It will build to appropriate formats / widths under /img/picset/

  • picture-100.jpg
  • picture-100.webp
  • picture-200.jpg
  • picture-200.webp
  • picture-400.jpg
  • picture-400.webp

Specification

Image types

Accepts .png and .jpg as input.

Outputs .webp and the input image type.

Image naming

Image size generation is done by naming convention with parameters denoted by the _{NUMBERS}{PARAM}. Examples:

Note: All examples will generate images with the name anthony at widths of 100px, 200px, and 400px

  1. anthony_400,200,100w.jpg - Name is anthony, file type is jpg
  2. anthony_400,200,100w_65jpg.jpg - Name is anthony, jpeg quality is 65%, file type is jpg
  3. anthony_400,200,100w_65jpg_50webp.jpg - Name is anthony, jpeg quality is 65%, webp quality is 50%, file type is jpg

Image naming: parameters

w - Image widths (Required)

Comma seperated list of integers for widths of output images

webp - .webp quality (Default: Set in plugin use() call or 80)

A integer from 1-100 indicating webp quality (lossy compression).

  • A value of 100 will trigger use of lossless compression mode

jpg - .jpg quality (Default: Set in plugin use() call or 80)

An integer from 1-100 indicating jpg quality (lossy compression).

Metalsmith options

Metalsmith options: Example object

{
    path: 'img/picset',
    jpg: 80,
    webp: 80
}

Which would place all images in img/picset with a default quality of 80 for both jpg and webp files

Metalsmith options: Specifics

path - images location (Default: img/picset/)

Place all your source images here. They should be high quality and high resolution.

  • Relative to Metalsmith source folder

jpg - Default jpg quality (Default: 80)

Default jpg quality if left unspecified in file name

webp - Default webp quality (Default: 80)

Default wbep quality if left unspecified in file name

Output

This plugin will generate images

  • In original format
  • In .webp format
  • At widths and qualities specified
  • At the specified path
  • Following a convention like {name}-{width}.{ext}
  • Removes original image

Background info

Recommendations

  • If you need optomized PNG output we recommended you add metalsmith-optipng to your pipeline.
  • Making a .png's dimensions smaller can sometimes increase filesize due to pecularities in the format's optomization methods and (we think) resizing can add additional pallet requirments. When making responsive .png files (and presumably lossless .webp files), review file sizes carefully.

Philosophy & architecture

  • Convention over Configuration
  • Image generation placed on file level instead of helper level
  • Generate once, use multiple times throughout site if desired
  • More likely to get cache hits by keeping standard file generation sizes on re-use
  • Seperate plugin for stages
  • Seperation of concerns (re-usable, if say someone wants to implement another templating engine solution than handlebars)
  • The Metalsmith way

Implementation

  • Uses sharp for image generation because sharp is fast
  • Implemented on Node v6.9.1, untested in other versions

install

npm i metalsmith-picset-generate

Downloadsweekly downloads

1

version

0.0.2

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability