makestatic-preset-optimize/README.md

Optimize lifecycle preset

# Optimize Preset

> Preset plugin configuration for the optimize phase

Configures the optimize lifecycle phase with standard plugins.

---

- [Install](#install)
- [API](#api)
  - [preset](#preset)
    - [Options](#options)
  - [See Also](#see-also)
- [License](#license)

---

## Install

```
yarn add makestatic-preset-optimize
```

## API

### preset

```javascript
preset(options)
```

Configures standard plugins for the optimize lifecycle phase.

Plugins are configured with sensible default values but you can override
the configuration when necessary.

* `options` Object plugin options.

#### Options

* `test` Object map of file test patterns.
* `html` Object options for the `optimize-html` plugin.
* `css` Object options for the `optimize-css` plugin.
* `js` Object options for the `optimize-js` plugin.
* `image` Object options for the `optimize-image` plugin.
* `inline` Object options for inline script and style compression.
* `exclude` Object map of excludes.

### See Also

* [Optimize HTML](https://makestatic.ws/docs/api/optimize-html/ "Optimize HTML")
* [Optimize CSS](https://makestatic.ws/docs/api/optimize-css/ "Optimize CSS")
* [Optimize JS](https://makestatic.ws/docs/api/optimize-js/ "Optimize JS")
* [Optimize Image](https://makestatic.ws/docs/api/optimize-image/ "Optimize Image")

## License

MIT

---

Created by [mkdoc](https://github.com/mkdoc/mkdoc) on March 12, 2017

[docs]: https://makestatic.ws/docs/ "Documentation"
[standalone manual]: https://github.com/makestatic/website/blob/master/MANUAL.md "Standalone Manual"
[yarn]: https://yarnpkg.com "Yarn"
[webpack]: https://webpack.js.org "Webpack"
[babel]: https://babeljs.io "Babel"
[postcss]: http://postcss.org "Postcss"
[sugarss]: https://github.com/postcss/sugarss "Sugarss"
[reshape]: https://github.com/reshape/reshape "Reshape Source Code"
[reshapeml]: https://reshape.ml "Reshape"
[clean-css]: https://github.com/jakubpawlowicz/clean-css "Clean CSS"
[html-minifier]: https://github.com/kangax/html-minifier "Html Minifier"
[uglify-js]: https://github.com/mishoo/UglifyJS2 "Uglify JS"
[imagemin]: https://github.com/imagemin/imagemin "Imagemin"
[mkdoc]: https://github.com/mkdoc/mkdoc "Mkdoc"
[browsersync]: https://www.browsersync.io "Browsersync"
[yeoman]: http://yeoman.io "Yeoman"
[spike]: https://www.spike.cf "Spike"
[validator]: https://github.com/validator/validator "HTML Validator"
[github pages]: https://pages.github.com "Github Pages"
[amazon s3]: https://aws.amazon.com/s3/ "Amazon S3"
[google sitemaps]: https://support.google.com/webmasters/answer/183668?hl=en&ref_topic=4581190 "Google Sitemaps"
[sitemaps]: https://www.sitemaps.org/ "Sitemaps"