https://github.com/targetkiller/gulp-imageisux

智图gulp插件
https://github.com/targetkiller/gulp-imageisux

Last synced: 3 months ago
JSON representation

智图gulp插件

• Host: GitHub
• URL: https://github.com/targetkiller/gulp-imageisux
• Owner: targetkiller
• Created: 2014-10-30T18:10:19.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-06-22T11:44:22.000Z (over 9 years ago)
• Last Synced: 2024-05-14T04:43:11.986Z (6 months ago)
• Language: JavaScript
• Size: 2.3 MB
• Stars: 385
• Watchers: 27
• Forks: 50
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-github-star - gulp-imageisux

README

        
#gulp-imageisux

[![NPM](https://nodei.co/npm/gulp-imageisux.png)](https://nodei.co/npm/gulp-imageisux/)

[智图](http://zhitu.isux.us/)的gulp插件

##Introduce

这是智图的gulp插件，它能自动压缩图片，并生成对应的webp格式(可选)。

你只需要声明`src(path)`图片源地址，并执行方法`pipe(imageisux())`就好了。

##Install

当然，你需要先安装[gulp](http://gulpjs.com/)。

```js

$ npm install --global gulp

```

然后安装插件。

```js

//全局安装

$ npm install --global gulp-imageisux

//局部安装

$ npm install --save-dev gulp-imageisux

```

##Usage

1、声明图片地址，例如放在img目录下面`gulp.src(['img/*'])`。

2、指定参数，压缩图片导出目录`/dest/`和是否同时导出webp格式。

```js

var imageisux = require('gulp-imageisux');

gulp.task('imageisux', function() {

	return gulp.src(['img/*'])

			   .pipe(imageisux('/dirpath/',true));

});

```

##API

两个参数，`dirpath`目标目录以及`enableWebp`是否同时导出对应WEBP格式图片。

 - `dirpath`: 如果未定义，会自动生成两个目录：'/dest/'目录放压缩后图片，'/webp/'目录放对应的webp格式压缩图片。

 - `enableWebp`  : 若为`true`，则会同时输出webp图片；若为`false`，则只会有压缩后原格式图片。