hakyll-images: Hakyll utilities to work with images

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

hakyll-images is an add-on to the hakyll package. It adds utilities to work with images, including JPEG compression.


[Skip to Readme]

Properties

Versions 0.0.1, 0.1.0, 0.2.0, 0.3.0, 0.3.1, 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4, 1.0.0, 1.0.1, 1.1.0, 1.1.1, 1.1.1
Change log CHANGELOG.md
Dependencies base (>=4.8 && <5), binary (>=0.5 && <1), bytestring (>=0.9 && <1), hakyll (>4 && <5), JuicyPixels (==3.*), JuicyPixels-extra (>0.3 && <1) [details]
License BSD-3-Clause
Author Laurent P. René de Cotret
Maintainer Laurent P. René de Cotret
Category Web
Home page https://github.com/LaurentRDC/hakyll-images#readme
Bug tracker https://github.com/LaurentRDC/hakyll-images/issues
Source repo head: git clone https://github.com/LaurentRDC/hakyll-images
Uploaded by LaurentRDC at 2021-10-04T22:59:34Z

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hakyll-images-1.1.1

[back to package description]

hakyll-images

Hackage version

A Haskell package containing utilities to deal with images in the context of Hakyll

Hakyll is a static website compiler library. As one of the benefits of static websites is their small size, this repository aims at providing utilities to work with images in the context of Hakyll. Example usage includes:

Usage

hakyll-images is meant to be integrated within a Hakyll program. Here are some examples within a Hakyll program:

import Hakyll
import Hakyll.Images        ( loadImage
                            , compressJpgCompiler
                            , resizeImageCompiler
                            , scaleImageCompiler
                            )

(...)

hakyll $ do

    -- Compress all source Jpegs to a Jpeg quality of 50 (maximum of 100)
    match "images/**.jpg" $ do
        route idRoute
        compile $ loadImage 
            >>= compressJpgCompiler 50

    -- Resize all profile pictures to 64x48
    -- Aspect ratio might be mangled
    match "profiles/**.jpg" $ do
        route idRoute
        compile $ loadImage 
            >>= resizeImageCompiler 64 48
            >>= compressJpgCompiler 50

    -- Scale images to fit within a 600x400 box
    -- Aspect ratio will be preserved
    match "images/**.png" $ do
        route idRoute
        compile $ loadImage
            >>= scaleImageCompiler 600 400

    (...)

Take a look at the documentation for more usage examples.

If you would like a feature added, consider creating an issue on Github

Installation

From Hackage

hakyll-images is available on Hackage. Using the cabal-install tool:

cabal update
cabal install hakyll-images

From source

Building from source can be done using stack or cabal:

git clone github.com/LaurentRDC/hakyll-images.git
cd hakyll-images
stack install # Alternatively, `cabal install`

Documentation

The documentation for the latest release is available on the Hackage page.

Support Issues / Feature requests

All support requests (e.g. installation issues, unclear documentation, bugs, etc.) should of filed on Github as an issue

License

This package is made available under the BSD 3-clause license. For more details, see the LICENSE.md