html-minifier

To prevent specific sections of your HTML from being minified, wrap them in the following comment tags:

<!-- htmlmin:ignore -->
<div class="preserved">This content will not be minified</div>
<!-- htmlmin:ignore -->

To run the built-in benchmarks for minified HTML, execute the following command in the repository root:

node benchmark.js

You can install html-minifier via NPM for either CLI or programmatic use, or directly from Git.

As a global CLI app:

npm install html-minifier -g

For programmatic use in projects:

npm install html-minifier

From Git:

git clone git://github.com/kangax/html-minifier.git
cd html-minifier
npm link .

You can provide a configuration file using the --config-file <file> flag. The CLI supports two formats for the config file:

1. JSON: A standard JSON file containing the option keys.
2. JavaScript Module: A .js file that exports a configuration object.

When using JSON for options that require arrays of regexes (like customAttrSurround), you must provide the regex as a string. The CLI will attempt to parse these strings into RegExp objects.

You can pass configuration objects to minifyCSS and minifyJS to use specialized minifiers:

Inline CSS

Pass an object to minifyCSS to configure clean-css. The library wraps CSS in a dummy selector to allow minification of inline styles.

Inline JavaScript

Pass an object to minifyJS to configure uglify-js.

• value.parse.bare_returns: Set to true if you want to allow bare returns in inline scripts.

URL Minification

Pass an object to minifyURLs to configure relateurl. If you pass a string, it is treated as the site base URL for relative path conversion.

Integrate html-minifier into a Gulp pipeline by calling htmlMinify.minify() on the file contents within a data event listener.

const { src, dest, series } = require('gulp');
const htmlMinify = require('html-minifier');

const options = {
  includeAutoGeneratedTags: true,
  removeAttributeQuotes: true,
  removeComments: true,
  removeRedundantAttributes: true,
  removeScriptTypeAttributes: true,
  removeStyleLinkTypeAttributes: true,
  sortClassName: true,
  useShortDoctype: true,
  collapseWhitespace: true
};

function html() {
  return src('app/**/*.html')
    .on('data', function(file) {
      const buferFile = Buffer.from(htmlMinify.minify(file.contents.toString(), options))
      return file.contents = buferFile
    })
    .pipe(dest('build'))
}

exports.html = series(html)

Import the minify function from html-minifier to process HTML strings programmatically.

var minify = require('html-minifier').minify;
var result = minify('<p title="blah" id="moo">foo</p>', {
  removeAttributeQuotes: true
});
result; // '<p title=blah id=moo>foo</p>'