The html-minifier npm package is a highly configurable, well-tested, JavaScript-based HTML minifier, with lint-like capabilities. It compresses HTML files by removing unnecessary whitespace, comments, and other unneeded characters without changing the functionality of the HTML. This can result in faster page load times and reduced bandwidth usage.

What are html-minifier's main functionalities?

Minify HTML

This feature collapses whitespace and strips out unnecessary spaces and line breaks to minimize the HTML file size.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<p>      Some HTML     </p>', {collapseWhitespace: true});
console.log(result); // Output: '<p>Some HTML</p>'

Remove Comments

This feature removes HTML comments to reduce the file size.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<!-- This is a comment --> <div>Content</div>', {removeComments: true});
console.log(result); // Output: '<div>Content</div>'

Remove Optional Tags

This feature removes optional tags like <html>, <head>, <body>, and <colgroup> when they are not necessary.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<html><head><title>Title</title></head><body><p>Content</p></body></html>', {removeOptionalTags: true});
console.log(result); // Output: '<title>Title</title><p>Content</p>'

Minify CSS

This feature minifies inline CSS reducing its size by removing unnecessary characters and whitespace.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<style>    .class { font-size: 18px; }    </style>', {minifyCSS: true});
console.log(result); // Output: '<style>.class{font-size:18px}</style>'

Minify JavaScript

This feature minifies inline JavaScript code by removing unnecessary characters and whitespace.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<script>    var name = "Your Name";    </script>', {minifyJS: true});
console.log(result); // Output: '<script>var name="Your Name";</script>'

Other packages similar to html-minifier

Readme

Source

HTMLMinifier is a Javascript-based HTML minifier (duh), with lint-like capabilities.

See corresponding blog post for all the gory details of how it works, description of each option, testing results and conclusions.

Test suite is available online.

Installing with npm:

npm install html-minifier

Building distribution:

> cat src/htmlparser.js src/htmlminifier.js src/htmllint.js > dist/all.js

Testing locally:

> npm test

Keywords

FAQs

What is html-minifier?

Is html-minifier well maintained?

Last updated on 21 Jan 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install