hexo-yam/README.md

# Hexo-yam

[![npm version](https://badge.fury.io/js/hexo-yam.svg)](https://www.npmjs.com/package/hexo-yam)
[![Build Status](https://travis-ci.com/weyusi/hexo-yam.svg?branch=master)](https://travis-ci.com/weyusi/hexo-yam)
[![NPM Dependencies](https://david-dm.org/weyusi/hexo-yam.svg)](https://david-dm.org/weyusi/hexo-yam)
[![Known Vulnerabilities](https://snyk.io/test/npm/hexo-yam/badge.svg)](https://snyk.io/test/npm/hexo-yam)
[![Greenkeeper badge](https://badges.greenkeeper.io/weyusi/hexo-yam.svg)](https://greenkeeper.io/)

> This project is based on [hexo-neat](https://github.com/rozbo/hexo-neat)

Yet Another Minifier for Hexo. Minify and compress html, js and css. Support gzip and [brotli](https://en.wikipedia.org/wiki/Brotli) [compressions](https://en.wikipedia.org/wiki/HTTP_compression).

The original package has not been [updated](https://www.npmjs.com/package/hexo-neat) for a while. I update the [dependencies](https://github.com/weyusi/hexo-yam/blob/master/package.json) and add compression support.

All the options are the same, so you can use this as a drop-in replacement.

## Installation
``` bash
$ npm install hexo-yam --save
```

## Usage
To enable this plugin, insert the following to `_config.yml`:
``` yaml
neat_enable: true
```
For further customization, see below.

## Options
``` yaml
neat_html:
  enable: true
  exclude:
```
- **enable** - Enable the plugin. Defaults to `true`.
- **logger** - Print log switch. Defaults to `true`.
- **exclude**: Exclude files
**Note:** For more options, see '[HTMLMinifier](https://github.com/kangax/html-minifier)'

----------

``` yaml
neat_css:
  enable: true
  exclude:
    - '*.min.css'
```
- **enable** - Enable the plugin. Defaults to `true`.
- **logger** - Print log switch. Defaults to `true`.
- **exclude**: Exclude files

----------

``` yaml
neat_js:
  enable: true
  mangle: true
  output:
  compress:
  exclude:
    - '*.min.js'
```
- **enable** - Enable the plugin. Defaults to `true`.
- **mangle**: Mangle file names
- **logger** - Print log switch. Defaults to `true`.
- **output**: Output options
- **compress**: Compress options
- **exclude**: Exclude files
**Note:** For more options, see '[UglifyJS](https://github.com/mishoo/UglifyJS2)'

----------

``` yaml
neat_gzip:
  enable: true
```
- **enable** - Enable the plugin. Defaults to `true`.
- **logger** - Print log switch. Defaults to `true`.

----------

``` yaml
neat_brotli:
  enable: true
```
- **enable** - Enable the plugin. Defaults to `true`.
- **logger** - Print log switch. Defaults to `true`.

## Credits
All credits go to the following work:
- [hexo-neat](https://github.com/rozbo/hexo-neat) by rozbo
- neat html by [HTMLMinifier](https://github.com/kangax/html-minifier)
- neat css  by [clean-css](https://github.com/jakubpawlowicz/clean-css)
- neat js   by  [UglifyJS](http://lisperator.net/uglifyjs/)
- gzip inspired by [hexo-generator-optimize](https://github.com/JackyRen/hexo-generator-optimize)
Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`# Hexo-yam`
add a badge 2016-06-23 05:27:24 +00:00
Add badges 2018-09-27 07:13:18 +00:00			`[![npm version](https://badge.fury.io/js/hexo-yam.svg)](https://www.npmjs.com/package/hexo-yam)`
Update travis badge 2018-09-27 07:49:26 +00:00			`[![Build Status](https://travis-ci.com/weyusi/hexo-yam.svg?branch=master)](https://travis-ci.com/weyusi/hexo-yam)`
Add badges 2018-09-27 07:13:18 +00:00			`[![NPM Dependencies](https://david-dm.org/weyusi/hexo-yam.svg)](https://david-dm.org/weyusi/hexo-yam)`
Remove hexo from travis 2018-09-28 02:24:17 +00:00			`[![Known Vulnerabilities](https://snyk.io/test/npm/hexo-yam/badge.svg)](https://snyk.io/test/npm/hexo-yam)`
			`[![Greenkeeper badge](https://badges.greenkeeper.io/weyusi/hexo-yam.svg)](https://greenkeeper.io/)`
Add badges 2018-09-27 07:13:18 +00:00
Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`> This project is based on [hexo-neat](https://github.com/rozbo/hexo-neat)`
Update formatting and ignore package-lock.json for npm publish 2018-09-27 06:55:30 +00:00
Add brotli compression 2018-09-30 07:30:32 +00:00			`Yet Another Minifier for Hexo. Minify and compress html, js and css. Support gzip and [brotli](https://en.wikipedia.org/wiki/Brotli) [compressions](https://en.wikipedia.org/wiki/HTTP_compression).`
Update formatting and ignore package-lock.json for npm publish 2018-09-27 06:55:30 +00:00
Show difference compared to hexo-neat Vulnerability statement is removed because this package has more severe vulnerability due to iltorb (for brotli). 2018-10-12 03:34:45 +00:00			`The original package has not been [updated](https://www.npmjs.com/package/hexo-neat) for a while. I update the [dependencies](https://github.com/weyusi/hexo-yam/blob/master/package.json) and add compression support.`
init code 2016-05-26 11:09:41 +00:00
Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`All the options are the same, so you can use this as a drop-in replacement.`
init code 2016-05-26 11:09:41 +00:00
			`## Installation`
			``` bash
Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`$ npm install hexo-yam --save`
init code 2016-05-26 11:09:41 +00:00			```

Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`## Usage`
			To enable this plugin, insert the following to `_config.yml`:
init code 2016-05-26 11:09:41 +00:00			``` yaml
readme 2016-05-26 11:23:57 +00:00			`neat_enable: true`
			```
Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`For further customization, see below.`
readme 2016-05-26 11:23:57 +00:00
Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`## Options`
readme 2016-05-26 11:23:57 +00:00			``` yaml
			`neat_html:`
init code 2016-05-26 11:09:41 +00:00			`enable: true`
add a badge 2016-06-23 05:27:24 +00:00			`exclude:`
init code 2016-05-26 11:09:41 +00:00			```
			- enable - Enable the plugin. Defaults to `true`.
Update README.md 2018-06-29 08:11:00 +00:00			- logger - Print log switch. Defaults to `true`.
init code 2016-05-26 11:09:41 +00:00			`- exclude: Exclude files`
uglify3 compatibility Credit to 8d9f2da8276652ef270e943dbf9dcb648e14ed55 2018-09-27 08:43:19 +00:00			`Note: For more options, see '[HTMLMinifier](https://github.com/kangax/html-minifier)'`
Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00
init code 2016-05-26 11:09:41 +00:00			`----------`

			``` yaml
readme 2016-05-26 11:23:57 +00:00			`neat_css:`
init code 2016-05-26 11:09:41 +00:00			`enable: true`
add a badge 2016-06-23 05:27:24 +00:00			`exclude:`
init code 2016-05-26 11:09:41 +00:00			`- '*.min.css'`
			```
			- enable - Enable the plugin. Defaults to `true`.
Update README.md 2018-06-29 08:11:00 +00:00			- logger - Print log switch. Defaults to `true`.
init code 2016-05-26 11:09:41 +00:00			`- exclude: Exclude files`

			`----------`

			``` yaml
readme 2016-05-26 11:23:57 +00:00			`neat_js:`
init code 2016-05-26 11:09:41 +00:00			`enable: true`
			`mangle: true`
			`output:`
			`compress:`
add a badge 2016-06-23 05:27:24 +00:00			`exclude:`
init code 2016-05-26 11:09:41 +00:00			`- '*.min.js'`
			```
			- enable - Enable the plugin. Defaults to `true`.
			`- mangle: Mangle file names`
Update README.md 2018-06-29 08:11:00 +00:00			- logger - Print log switch. Defaults to `true`.
init code 2016-05-26 11:09:41 +00:00			`- output: Output options`
			`- compress: Compress options`
			`- exclude: Exclude files`
uglify3 compatibility Credit to 8d9f2da8276652ef270e943dbf9dcb648e14ed55 2018-09-27 08:43:19 +00:00			`Note: For more options, see '[UglifyJS](https://github.com/mishoo/UglifyJS2)'`
init code 2016-05-26 11:09:41 +00:00
Add gzip compression 2018-09-28 07:43:54 +00:00			`----------`

			``` yaml
Update readme for gzip option 2018-09-29 05:58:43 +00:00			`neat_gzip:`
Add gzip compression 2018-09-28 07:43:54 +00:00			`enable: true`
			```
			- enable - Enable the plugin. Defaults to `true`.
Update readme for gzip option 2018-09-29 05:58:43 +00:00			- logger - Print log switch. Defaults to `true`.
init code 2016-05-26 11:09:41 +00:00
Add brotli compression 2018-09-30 07:30:32 +00:00			`----------`

			``` yaml
			`neat_brotli:`
			`enable: true`
			```
			- enable - Enable the plugin. Defaults to `true`.
			- logger - Print log switch. Defaults to `true`.

Update dependency html-minifier <3.5.0 has ReDoS vulnerability https://snyk.io/test/npm/hexo-neat 2018-09-27 05:27:16 +00:00			`## Credits`
			`All credits go to the following work:`
			`- [hexo-neat](https://github.com/rozbo/hexo-neat) by rozbo`
readme 2016-05-26 11:23:57 +00:00			`- neat html by [HTMLMinifier](https://github.com/kangax/html-minifier)`
			`- neat css by [clean-css](https://github.com/jakubpawlowicz/clean-css)`
			`- neat js by [UglifyJS](http://lisperator.net/uglifyjs/)`
Update readme for gzip option 2018-09-29 05:58:43 +00:00			`- gzip inspired by [hexo-generator-optimize](https://github.com/JackyRen/hexo-generator-optimize)`