Skip to main content

Extremely fast and smart HTML + JS + CSS minifier

Project description

minify-html

A Rust HTML minifier meticulously optimised for speed and effectiveness, with bindings for other languages.

  • Advanced minification strategy beats other minifiers while being much faster.
  • Uses SIMD searching, direct tries, and lookup tables.
  • Handles invalid HTML, with extensive testing and fuzzing.
  • Uses minify-js for super fast JS minification.

View the changelog to see the latest updates.

Performance

Comparison with html-minifier and minimize, run on the top web pages. See the breakdown here.

Chart showing speed of HTML minifiersChart showing compression of HTML minifiers

The onepass variant is even more optimised for speed. See its README for more details.

Compatibility and usage

CLI

Precompiled binaries are available for Linux, macOS, and Windows.

Get

Linux x64 | Linux ARM64 | macOS x64 | Windows x64

Use

Use the --help argument for more details.

minify-html --output /path/to/output.min.html --keep-closing-tags --minify-css /path/to/src.html

To quickly parallel process a batch of files in place:

minify-html --keep-closing-tags --minify-css /path/to/**/*.html
Rust

Get

[dependencies]
minify-html = "0.11.0"

Use

Check out the docs for API and usage examples.

Deno

Use

import init, {minify} from "https://wilsonl.in/minify-html/deno/0.11.0/index.js";

const encoder = new TextEncoder();
const decoder = new TextDecoder();

await init();

const minified = decoder.decode(minify(encoder.encode("<p>  Hello, world!  </p>"), { keep_spaces_between_attributes: true, keep_comments: true }));

All Cfg fields are available as snake_case properties on the object provided as the second argument; if any are not set, they default to false.

Node.js
  • Package: @minify-html/node
  • Binding: Neon
  • Platforms: Linux (ARM64 and x64), macOS (x64), Windows (x64); Node.js 8.6.0 and higher

Get

Using npm:

npm i @minify-html/node

Using Yarn:

yarn add @minify-html/node

Use

TypeScript definitions are available.

import { Buffer } from "node:buffer";
import minifyHtml from "@minify-html/node";
// Or `const minifyHtml = require("@minify-html/node")` if not using TS/ESM.

const minified = minifyHtml.minify(Buffer.from("<p>  Hello, world!  </p>"), { keep_spaces_between_attributes: true, keep_comments: true });

All Cfg fields are available as snake_case properties on the object provided as the second argument; if any are not set, they default to false.

Java

Get

Add as a Maven dependency:

<dependency>
  <groupId>in.wilsonl.minifyhtml</groupId>
  <artifactId>minify-html</artifactId>
  <version>0.11.0</version>
</dependency>

Use

import in.wilsonl.minifyhtml.Configuration;
import in.wilsonl.minifyhtml.MinifyHtml;

Configuration cfg = new Configuration.Builder()
    .setKeepHtmlAndHeadOpeningTags(true)
    .setMinifyCss(true)
    .build();

String minified = MinifyHtml.minify("<p>  Hello, world!  </p>", cfg);

All Cfg fields are available as camelCase setter methods on the Builder; if any are not set, they default to false.

Python
  • Package: minify-html
  • Binding: PyO3
  • Platforms: Linux (ARM64 and x64), macOS (x64), Windows (x64); Python 3.8 to 3.10

Get

Add the PyPI project as a dependency and install it using pip or pipenv.

Use

import minify_html

minified = minify_html.minify("<p>  Hello, world!  </p>", minify_js=True, remove_processing_instructions=True)

All Cfg fields are available as Python keyword arguments; if any are omitted, they default to False.

Ruby
  • Package: minify_html
  • Binding: Rutie
  • Platforms: Linux, macOS; Ruby 2.5 and higher

Get

Add the library as a dependency to Gemfile or *.gemspec.

Use

require 'minify_html'

print MinifyHtml.minify("<p>  Hello, world!  </p>", { :keep_spaces_between_attributes => true, :minify_js => true })

All Cfg fields are available; if any are omitted, they default to false.

WASM

A bundler may be required to use the WebAssembly module, see this for more details.

Use

import init, {minify} from "@minify-html/wasm";

const encoder = new TextEncoder();
const decoder = new TextDecoder();

await init();

const minified = decoder.decode(minify(encoder.encode("<p>  Hello, world!  </p>"), { keep_spaces_between_attributes: true, keep_comments: true }));

All Cfg fields are available as snake_case properties on the object provided as the second argument; if any are not set, they default to false.

Minification

Note that some of the minification done can result in HTML that will not pass validation, but remain interpreted and rendered correctly by the browser; essentially, the laxness of the browser is taken advantage of for better minification. To prevent this, refer to these configuration options:

  • do_not_minify_doctype
  • ensure_spec_compliant_unquoted_attribute_values
  • keep_spaces_between_attributes

Whitespace

minify-html has advanced context-aware whitespace minification that does things such as:

  • Leave whitespace untouched in pre and code, which are whitespace sensitive.
  • Trim and collapse whitespace in content tags, as whitespace is collapsed anyway when rendered.
  • Remove whitespace in layout tags, which allows the use of inline layouts while keeping formatted code.

Methods

There are three whitespace minification methods. When processing text content, minify-html chooses which ones to use depending on the containing element.

Collapse whitespace

Applies to: any element except whitespace sensitive elements.

Reduce a sequence of whitespace characters in text nodes to a single space (U+0020).

BeforeAfter
<p>↵
··The·quick·brown·fox↵
··jumps·over·the·lazy↵
··dog.↵
</p>
<p>·The·quick·brown·fox·jumps·over·the·lazy·dog.·</p>
Destroy whole whitespace

Applies to: any element except whitespace sensitive, content, content-first, and formatting elements.

Remove any text nodes between tags that only consist of whitespace characters.

BeforeAfter
<ul>↵
··<li>A</li>↵
··<li>B</li>↵
··<li>C</li></ul>
<ul>↵
··<li>A</li><li>B</li><li>C</li></ul>
Trim whitespace

Applies to: any element except whitespace sensitive and formatting elements.

Remove any leading/trailing whitespace from any leading/trailing text nodes of a tag.

BeforeAfter
<p>↵
··Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup></p>
<p>Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup></p>

Element types

minify-html assumes HTML and SVG elements are used in specific ways, based on standards and best practices. By making these assumptions, it can apply optimal whitespace minification strategies. If these assumptions do not hold, consider adjusting the HTML source or turning off whitespace minification.

Group Elements Expected children
Formatting a, strong, and others Formatting elements, text.
Content h1, p, and others Formatting elements, text.
Layout div, ul, and others Layout elements, content elements.
Content-first label, li, and others Like content but could be layout with only one child.
Formatting elements

Whitespace is collapsed.

Formatting elements are usually inline elements that wrap around part of some text in a content element, so its whitespace isn't trimmed as they're probably part of the content.

Content elements

Whitespace is trimmed and collapsed.

Content elements usually represent a contiguous and complete unit of content such as a paragraph. As such, whitespace is significant but sequences of them are most likely due to formatting.

Before
<p>↵
··Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup></p>
After
<p>Hey,·I·<em>just</em>·found·out·about·this·<strong>cool</strong>·website!·<sup>[1]</sup></p>
Layout elements

Whitespace is trimmed and collapsed. Whole whitespace is removed.

These elements should only contain other elements and no text. This makes it possible to remove whole whitespace, which is useful when using display: inline-block so that whitespace between elements (e.g. indentation) does not alter layout and styling.

Before
<ul>↵
··<li>A</li>↵
··<li>B</li>↵
··<li>C</li></ul>
After
<ul><li>A</li><li>B</li><li>C</li></ul>
Content-first elements

Whitespace is trimmed and collapsed.

These elements are usually like content elements but are occasionally used like a layout element with one child. Whole whitespace is not removed as it might contain content, but this is OK for using as layout as there is only one child and whitespace is trimmed.

Before
<li>↵
··<article>↵
····<section></section>↵
····<section></section>↵
··</article></li>
After
<li><article><section></section><section></section></article></li>

Tags

Optional opening and closing tags are removed.

Attributes

Any entities in attribute values are decoded, and then the shortest representation of the value is calculated and used:

  • Double quoted, with any " encoded.
  • Single quoted, with any ' encoded.
  • Unquoted, with "/' first character (if applicable), any >, and any whitespace encoded.

Attributes have their whitespace (after any decoding) trimmed and collapsed when possible.

Boolean attribute values are removed. Some other attributes are completely removed if their value is empty or the default value after any processing.

type attributes on script tags with a value equaling a JavaScript MIME type are removed.

If an attribute value is empty after any processing, everything but the name is completely removed (i.e. no =), as an empty attribute is implicitly the same as an attribute with an empty string value.

Spaces are removed between attributes when possible.

Entities

Entities are decoded if they're valid and shorter or equal in length when decoded. UTF-8 sequences that have a shorter entity representation are encoded.

Numeric entities that do not refer to a valid Unicode Scalar Value are replaced with the replacement character.

Encoding is avoided when possible; for example, < are only encoded in content if they are followed by a valid tag name character. If necessary, the shortest entity representation is chosen.

Comments

Comments are removed.

Ignored

Bangs, processing instructions, and empty elements are not removed as it is assumed there is a special reason for their declaration.

Parsing

minify-html can process any HTML, handling all possible syntax (including invalid ones) gracefully like browsers. See Parsing.md for more details.

Issues and contributions

Pull requests and any contributions welcome!

If minify-html did something unexpected, misunderstood some syntax, or incorrectly kept/removed some code, raise an issue with some relevant code that can be used to reproduce and investigate the issue.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minify_html-0.11.0.tar.gz (136.4 kB view details)

Uploaded Source

Built Distributions

minify_html-0.11.0-cp311-none-win_amd64.whl (558.1 kB view details)

Uploaded CPython 3.11Windows x86-64

minify_html-0.11.0-cp311-cp311-macosx_10_7_x86_64.whl (623.1 kB view details)

Uploaded CPython 3.11macOS 10.7+ x86-64

minify_html-0.11.0-cp310-none-win_amd64.whl (558.1 kB view details)

Uploaded CPython 3.10Windows x86-64

minify_html-0.11.0-cp310-cp310-macosx_10_7_x86_64.whl (623.1 kB view details)

Uploaded CPython 3.10macOS 10.7+ x86-64

minify_html-0.11.0-cp39-none-win_amd64.whl (558.1 kB view details)

Uploaded CPython 3.9Windows x86-64

minify_html-0.11.0-cp39-cp39-macosx_10_7_x86_64.whl (623.1 kB view details)

Uploaded CPython 3.9macOS 10.7+ x86-64

minify_html-0.11.0-cp38-none-win_amd64.whl (557.9 kB view details)

Uploaded CPython 3.8Windows x86-64

minify_html-0.11.0-cp38-cp38-macosx_10_7_x86_64.whl (623.1 kB view details)

Uploaded CPython 3.8macOS 10.7+ x86-64

File details

Details for the file minify_html-0.11.0.tar.gz.

File metadata

  • Download URL: minify_html-0.11.0.tar.gz
  • Upload date:
  • Size: 136.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for minify_html-0.11.0.tar.gz
Algorithm Hash digest
SHA256 827d0b3ba16a02fbc9f634f4f340ec58efd00ac5131b6ce9d30a4eeb463d1175
MD5 8a96f23f1b7941fdb3d4fada43d77aac
BLAKE2b-256 df550490d40bd27f37c1e4b286ca62da5842c125471b9f27aeffa053edcc95c7

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp311-none-win_amd64.whl.

File metadata

File hashes

Hashes for minify_html-0.11.0-cp311-none-win_amd64.whl
Algorithm Hash digest
SHA256 753ce9bb1993f64ca888cf89b9fb572e2d6e9903ab3f498b515b937594f1f1e8
MD5 a3d9ce57a66d25824dfe62d086212c2a
BLAKE2b-256 97455b6743a065879cc602ce6436236c9de6bbf51664c589a1274c2a6bf4bbf2

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp311-cp311-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for minify_html-0.11.0-cp311-cp311-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 1d2f617ae05686f8d09b79ec70c310618c32b32ab64434b411f8e0d9ee28973f
MD5 62617871aa5d2f0ff53a952c221f1236
BLAKE2b-256 c06bf1718aac0a20c462b082072f9eb467cf8e7caccb816a0ce32a00c33a47f5

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp310-none-win_amd64.whl.

File metadata

File hashes

Hashes for minify_html-0.11.0-cp310-none-win_amd64.whl
Algorithm Hash digest
SHA256 9dc80747a4d743a1ae97bd9455171faf8afa9fc1a7ed07e3af1683940531b1fb
MD5 b211d032a015f5713a5ad9b9cfd3219d
BLAKE2b-256 25a049455101e7ca79c724c4cbbfec86a028e56c710889b9f0d51548e485d050

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp310-cp310-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for minify_html-0.11.0-cp310-cp310-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 2eea96193a9e913096ba8735852bedd175862d4e121639dd158146f9057312bb
MD5 b7823849460e3dca39bbd5d0581ceba3
BLAKE2b-256 c5072eb5e06d79af75222f3253fe518260d8a82ce95bc1a30d45960f61a9eb90

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp39-none-win_amd64.whl.

File metadata

  • Download URL: minify_html-0.11.0-cp39-none-win_amd64.whl
  • Upload date:
  • Size: 558.1 kB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for minify_html-0.11.0-cp39-none-win_amd64.whl
Algorithm Hash digest
SHA256 17ef1ddcfa4ebe677cd716968a9b10474b19e48533d809add704a147d2f34d55
MD5 a608a1811885b56c05492df5eb926b5d
BLAKE2b-256 0750268e22fcbbf291ae4af5172dda4b1758dcb3c992b29306a4c4000b42a502

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp39-cp39-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for minify_html-0.11.0-cp39-cp39-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 616ea84c16ca1df060e11af34576b5c27420cfcd672c22e1ead47f826cc6ac06
MD5 26a4292b876ae39fd2868a32e878ef93
BLAKE2b-256 31a465cd1cc5850c3723928dce9189bc6d722ebfbb3680d18f57044379905f88

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp38-none-win_amd64.whl.

File metadata

  • Download URL: minify_html-0.11.0-cp38-none-win_amd64.whl
  • Upload date:
  • Size: 557.9 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for minify_html-0.11.0-cp38-none-win_amd64.whl
Algorithm Hash digest
SHA256 5ca4a1ae2876dd85a0673d917700b06df1b79e0162d0a5fd451fe6adb90bd6a2
MD5 8413cca31b19b730be08b4f341297896
BLAKE2b-256 1a48e63f7c92f58a71b0bd5bac7eb47ac61a77d909056e0c3e9513c04fafc21a

See more details on using hashes here.

File details

Details for the file minify_html-0.11.0-cp38-cp38-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for minify_html-0.11.0-cp38-cp38-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 c3360a36f3799c83347c5078cba19cd395546d7a831ba84375e743c1467bf8a1
MD5 ddc0c6fe2212174021a4ae2ee46382c1
BLAKE2b-256 ff57a5efadd70e6594d217c51c3ba38c41dd0198a4cff44f104d4fd7dfd2c130

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page