Install

To install the library, you can use pip

$ pip install pelican-advthumbnailer

Usage

1. Update pelicanconf.py:

   1. Add advthumbnailer to PLUGINS.

      You should add it before any image optimization plugins.

      PLUGINS = [..., 'advthumbnailer']

2. Creating a thumbnail:

   1. Ensure original image is copied to the output folder (add to STATIC_PATHS or use the autostatic plugin).

      E.g: output/images/example.png

   2. Add an <img> (or a <source> tag) containing as source (or scrset):

      images/thumbnails/<spec>/example.png

      Where <spec> is one of the following:

      • <number>: Perform a square resize of the image to <number>x<number> pixels.

      • <number1>x<number2>: Perform a scale and crop resize of the image to <number1>x<number2> pixels.

      • <number1>x_ or _x<number2>: Perform an aspect-preserving resize of the image enforcing the specified with or height, respectively, in pixels.

      <spec> can also be terminated with a ! in which case upscales (e.g: resize 100px to 200px) will also be allowed. By default this is not the case.

      Example:

      <img src="images/thumbnails/100x_/example.png" />

   3. Upon output generation, all files are scanned for image sources and those matching the .*thumbnails/<spec>/.+ regex are thumbnailed according to the <spec>.

Options

• ADVTHUMB_SEARCH_IMAGES_IN_ANCHORS (default: False): Boolean option that determines if advthumbnailer should consider the href attribute of <a> elements as thumbnail paths.

• ADVTHUMB_QUALITY (default: 70): Int option that determines quality of generated thumbnails.

• ADVTHUMB_OPTIMIZE (default: True): Boolean option that determines if generated thumbnails should be optimized.

• ADVTHUMB_PROGRESSIVE (default: True): Boolean option that determines if generated thumbnails should be progressive.

Integrations

{static images/example.png thumb="100x_"}

<img src="{{ SITEURL + "images/example.png" | thumbnail("100x_") }}" />

Example usage

For a working example check my site and my site’s source code.