https://github.com/divspace/elixir-imagemin

https://github.com/divspace/elixir-imagemin

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/divspace/elixir-imagemin
• Owner: divspace
• Created: 2016-04-15T21:43:51.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-04-15T21:44:36.000Z (over 8 years ago)
• Last Synced: 2024-10-01T15:43:43.949Z (about 2 months ago)
• Language: JavaScript
• Size: 1.95 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# elixir-imagemin

This is a simple imagemin wrapper around Laravel Elixir. Add it to your Elixir-enhanced Gulpfile, like so:

## Install

```

npm install --save-dev elixir-imagemin

```

## Usage

### Example *Gulpfile*:

```javascript

var elixir = require('laravel-elixir');

require('elixir-imagemin');

elixir(function(mix) {

   mix.imagemin();

});

```

This will scan your `resources/assets/img` directory for all image files.

### Changing the default image directories

If you want to process a different image directory, you can update your Elixir config by either:

#### Defining `elixir.config.img` in your *Gulpfile*

You can define `elixir.config.img` in your `gulpfile.js` like so:

```javascript

var elixir = require('laravel-elixir');

require('elixir-imagemin');

elixir.config.img = {

    folder: 'images',

    outputFolder: 'images'

};

elixir(function(mix) {

   mix.imagemin();

});

```

#### Setting `config.img` in an `elixir.json` file

You can create an [`elixir.json`](https://github.com/laravel/elixir/blob/dfd6655537eb3294a4c71e826cd0e8a6f6b2108b/index.js#L50-L67)

file in your project root to modify Elixir's default settings.

```json

{

    "img": {

        "folder": "images",

        "outputFolder": "images"

    }

}

```

#### Upgrading from the old syntax

If you're upgrading from the old syntax, where you defined custom directories like so:

```javascript

mix.imagemin("./resources/assets/img", "public/img/foo/bar/");

```

All you have to do is:

- Remove the first two parameters, then

- Follow the instructions for ["Changing the default image directories"](#changing-the-default-image-directories)

**Note**: You don't define the full path anymore. Instead of `resources/assets/img` you simply use `img`, because

elixir-imagemin will look inside your `assets` and `public` directories (or whatever else you may have

configured).

### Custom imagemin options

You can override the default imagemin options by passing in an options object like so:

```javascript

mix.imagemin({

    optimizationLevel: 3,

    progressive: true,

    interlaced: true

});

```

Available imagemin options are listed [here in the gulp-imagemin readme](https://github.com/sindresorhus/gulp-imagemin#imageminoptions).