hexo-yam/README.md

69 lines
1.7 KiB
Markdown
Raw Normal View History

# Hexo-yam
2016-06-23 05:27:24 +00:00
> This project is based on [hexo-neat](https://github.com/rozbo/hexo-neat)
Yet Another Minifier for Hexo.
The original package has not been [updated](https://www.npmjs.com/package/hexo-neat) for a while. Its outdated dependencies suffer from minor [vulnerability](https://snyk.io/test/npm/hexo-neat).
2016-05-26 11:09:41 +00:00
All the options are the same, so you can use this as a drop-in replacement.
2016-05-26 11:09:41 +00:00
## Installation
``` bash
$ npm install hexo-yam --save
2016-05-26 11:09:41 +00:00
```
## Usage
To enable this plugin, insert the following to `_config.yml`:
2016-05-26 11:09:41 +00:00
``` yaml
2016-05-26 11:23:57 +00:00
neat_enable: true
```
For further customization, see below.
2016-05-26 11:23:57 +00:00
## Options
2016-05-26 11:23:57 +00:00
``` yaml
neat_html:
2016-05-26 11:09:41 +00:00
enable: true
2016-06-23 05:27:24 +00:00
exclude:
2016-05-26 11:09:41 +00:00
```
- **enable** - Enable the plugin. Defaults to `true`.
2018-06-29 08:11:00 +00:00
- **logger** - Print log switch. Defaults to `true`.
2016-05-26 11:09:41 +00:00
- **exclude**: Exclude files
2016-05-26 11:23:57 +00:00
**Note:** there are so many params please see '[HTMLMinifier](https://github.com/kangax/html-minifier)'
2016-05-26 11:09:41 +00:00
----------
``` yaml
2016-05-26 11:23:57 +00:00
neat_css:
2016-05-26 11:09:41 +00:00
enable: true
2016-06-23 05:27:24 +00:00
exclude:
2016-05-26 11:09:41 +00:00
- '*.min.css'
```
- **enable** - Enable the plugin. Defaults to `true`.
2018-06-29 08:11:00 +00:00
- **logger** - Print log switch. Defaults to `true`.
2016-05-26 11:09:41 +00:00
- **exclude**: Exclude files
----------
``` yaml
2016-05-26 11:23:57 +00:00
neat_js:
2016-05-26 11:09:41 +00:00
enable: true
mangle: true
output:
compress:
2016-06-23 05:27:24 +00:00
exclude:
2016-05-26 11:09:41 +00:00
- '*.min.js'
```
- **enable** - Enable the plugin. Defaults to `true`.
- **mangle**: Mangle file names
2018-06-29 08:11:00 +00:00
- **logger** - Print log switch. Defaults to `true`.
2016-05-26 11:09:41 +00:00
- **output**: Output options
- **compress**: Compress options
- **exclude**: Exclude files
## Credits
All credits go to the following work:
- [hexo-neat](https://github.com/rozbo/hexo-neat) by rozbo
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/)