Hexo-yam

---

Yet Another Minifier for Hexo. Minify and compress HTML, JS, CSS and SVG. XML, JSON and many more are also compressed. Support gzip and brotli compressions.

This project is based on hexo-neat. Existing options are the same, so you can use this as a drop-in replacement.

Note: See HTTP Compression section below for more info on using brotli.

Installation

$ npm install hexo-yam --save

Usage

To enable this plugin, insert the following to _config.yml:

neat_enable: true

For further customization, see below.

Options

neat_html:
  enable: true
  exclude:

• enable - Enable the plugin. Defaults to true.
• logger - Verbose output. Defaults to false.
• exclude - Exclude files.
  • Support one-liner, exclude: [*.min.html, *.note.html].
  • To exclude a file, double asterisk and the full path must be specified, **/themes/typing/source/js/source.js.
  • *source.js also works, but it also excludes resource.js.
  • Test glob pattern on the web using Globtester.
• globOptions - micromatch options to customise how glob patterns match files. Defaults to { basename: true }, unless the pattern has a slash.

For more options, see HTMLMinifier.

---

neat_css:
  enable: true
  exclude:
    - '*.min.css'

• enable - Enable the plugin. Defaults to true.
• logger - Verbose output. Defaults to false.
• exclude - Exclude files. Support wildcard pattern.
• level - Optimization level. Defaults to 2.
• globOptions - See neat_html.

For more options, see clean-css.

---

neat_js:
  enable: true
  exclude:
    - '*.min.js'

• enable - Enable the plugin. Defaults to true.
• logger - Verbose output. Defaults to false.
• exclude - Exclude files. Support wildcard pattern.
• compress - Compress options.
• mangle - Mangle variable names. Defaults to true. Pass an object to specify mangle options.
• output - Output options.
  • To retain comments, output: {comments: true}.
• globOptions - See neat_html.

For more options, see Terser.

---

neat_svg:
  enable: true
  include:
    - '*.svg'
    - '!*.min.svg'

• enable - Enable the plugin. Defaults to true.
• logger - Verbose output. Defaults to false.
• include - Include files. Support wildcard pattern.
  • Exclude *.min.svg by default.
• plugins - Plugin options.
  • To retain comments, plugins: [{removeComments: false}].
• globOptions - See neat_html.

For more options, see svgo.

---

neat_gzip:
  enable: true
  include:
    - '*.html'
    - '*.css'
    - '*.js'
    - '*.txt'
    - '*.ttf'
    - '*.atom'
    - '*.stl'
    - '*.xml'
    - '*.svg'
    - '*.eot'
    - '*.json'

• enable - Enable the plugin. Defaults to true.
• logger - Verbose output. Defaults to false.
• include - Include files. Support wildcard pattern.
  • Support one-liner, include: ['*.html','*.css','*.js'].
  • Must include asterisk and single quotes. .html is invalid. '*.html' is valid.
• globOptions - See neat_html.

---

neat_brotli:
  enable: true
  include:
    - '*.html'
    - '*.css'
    - '*.js'
    - '*.txt'
    - '*.ttf'
    - '*.atom'
    - '*.stl'
    - '*.xml'
    - '*.svg'
    - '*.eot'
    - '*.json'

• enable - Enable the plugin. Defaults to true.
• logger - Verbose output. Defaults to false.
• include - Include files. Support wildcard pattern.
• globOptions - See neat_html.

HTTP Compression

While most modern web browsers support Brotli, you also need to consider whether the web/app server, hosting platform, reverse proxy or CDN (whichever relevant to you) support it.

As of May 2019, GitHub Pages, GitLab Pages and Netlify do not support brotli yet. You can generate .br files, but they won't serve those files.

Name	Status (May 8, 2019)
GitHub Pages	In consideration
GitLab Pages	In progress
Netlify	In consideration

If you have access to the web server config, you should disable on-the-fly compression for static files (that are already compressed by this plugin),

• nginx: Make sure both filter and static modules are enabled. This way pre-compressed .br files will be served while dynamic content can be compressed on-the-fly. Protip: brotli_types text/plain text/css application/javascript application/json image/svg+xml application/xml+rss; to prevent compressing media files (which are already compressed anyway).
• Apache: See 'Serving pre-compressed content' section of mod_brotli.
• Caddy: 0.9.4+ by default support pre-compressed .gz .br files and on-the-fly gzip compress dynamic files.
• express/connect: Use pre-compressed-assets. You still can continue to use compression/shrink-ray-current for dynamic files.

Credits

All credits go to the following work:

• hexo-neat by rozbo
• neat html by HTMLMinifier
• neat css by clean-css
• neat js by terser
• gzip feature is inspired by hexo-generator-optimize