biofriction-wp-theme/node_modules/imagemin-svgo/readme.md

57 lines
842 B
Markdown

# imagemin-svgo [![Build Status](https://travis-ci.org/imagemin/imagemin-svgo.svg?branch=master)](https://travis-ci.org/imagemin/imagemin-svgo)
> [SVGO](https://github.com/svg/svgo) imagemin plugin
## Install
```
$ npm install imagemin-svgo
```
## Usage
```js
const imagemin = require('imagemin');
const imageminSvgo = require('imagemin-svgo');
(async () => {
await imagemin(['images/*.svg'], 'build/images', {
use: [
imageminSvgo({
plugins: [
{removeViewBox: false}
]
})
]
});
console.log('Images optimized');
})();
```
## API
### imageminSvgo([options])(buffer)
Returns a `Promise<Buffer>`.
#### options
Type: `Object`
Pass options to [SVGO](https://github.com/svg/svgo#what-it-can-do).
#### buffer
Type: `Buffer`
Buffer to optimize.
## License
MIT © [imagemin](https://github.com/imagemin)