Package: minify-html
minify-htmlA 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.Handlesinvalid HTML, with extensive testing andfuzzing.Usesminify-jsandlightningcssfor super fast JS and CSS minification.View thechangelogto see the latest updates.PerformanceComparison withhtml-minifierandminimize, run on the top web pages.See the breakdown here.Theonepassvariant is even more optimised for speed. See itsREADMEfor more details.Compatibility and usageCLIThe CLI is calledminhtml.
Precompiled binaries are available for Linux (ARM64 and x64), macOS (ARM64 and x64), and Windows (x64).
You can download them in the GitHub release.If you have Cargo installed, you can also build and install from source:cargo install minhtml.UseUse the--helpargument for more details.minhtml--output/path/to/output.min.html--keep-closing-tags--minify-css/path/to/src.htmlTo quickly parallel process a batch of files in place:minhtml--keep-closing-tags--minify-css/path/to/**/*.htmlRustGet[dependencies]minify-html="0.15.0"UseCheck out thedocsfor API and usage examples.DenoPackage:https://wilsonl.in/minify-html/deno/0.15.0/index.jsBinding:WASMPlatforms: AllUseimportinit,{minify}from"https://wilsonl.in/minify-html/deno/0.15.0/index.js";constencoder=newTextEncoder();constdecoder=newTextDecoder();awaitinit();constminified=decoder.decode(minify(encoder.encode("<p>  Hello, world!  </p>"),{keep_spaces_between_attributes:true,keep_comments:true}));AllCfgfieldsare available as snake_case properties on the object provided as the second argument; if any are not set, they default tofalse.Node.jsPackage:@minify-html/nodeBinding:NeonPlatforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Node.js 8.6.0 and higherGetUsing npm:npmi@minify-html/nodeUsing Yarn:yarnadd@minify-html/nodeUseTypeScript definitions are available.import{Buffer}from"node:buffer";importminifyHtmlfrom"@minify-html/node";// Or `const minifyHtml = require("@minify-html/node")` if not using TS/ESM.constminified=minifyHtml.minify(Buffer.from("<p>  Hello, world!  </p>"),{keep_spaces_between_attributes:true,keep_comments:true});AllCfgfieldsare available as snake_case properties on the object provided as the second argument; if any are not set, they default tofalse.JavaPackage:in.wilsonl.minifyhtmlBinding:JNIPlatforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Java 7 and higherGetAdd as a Maven dependency:<dependency><groupId>in.wilsonl.minifyhtml</groupId><artifactId>minify-html</artifactId><version>0.15.0</version></dependency>Useimportin.wilsonl.minifyhtml.Configuration;importin.wilsonl.minifyhtml.MinifyHtml;Configurationcfg=newConfiguration.Builder().setKeepHtmlAndHeadOpeningTags(true).setMinifyCss(true).build();Stringminified=MinifyHtml.minify("<p>  Hello, world!  </p>",cfg);AllCfgfieldsare available as camelCase setter methods on theBuilder; if any are not set, they default tofalse.PythonPackage:minify-htmlBinding:PyO3Platforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Python 3.8 to 3.12GetAdd the PyPI project as a dependency and install it usingpiporpipenv.Useimportminify_htmlminified=minify_html.minify("<p>  Hello, world!  </p>",minify_js=True,remove_processing_instructions=True)AllCfgfieldsare available as Python keyword arguments; if any are omitted, they default toFalse.RubyPackage:minify_htmlBinding:rb-sysandmagnusPlatforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Ruby 2.7 to 3.2GetAdd the library as a dependency toGemfileor*.gemspec.Userequire'minify_html'printminify_html("<p>  Hello, world!  </p>",{:keep_spaces_between_attributes=>true,:minify_js=>true})AllCfgfieldsare available; if any are omitted, they default tofalse.WASMPackage:@minify-html/wasmBinding:WASMPlatforms: AllA bundler may be required to use the WebAssembly module, seethisfor more details.Useimportinit,{minify}from"@minify-html/wasm";constencoder=newTextEncoder();constdecoder=newTextDecoder();awaitinit();constminified=decoder.decode(minify(encoder.encode("<p>  Hello, world!  </p>"),{keep_spaces_between_attributes:true,keep_comments:true}));AllCfgfieldsare available as snake_case properties on the object provided as the second argument; if any are not set, they default tofalse.Templating syntaxminify-html can parse and preserve{{/{%/{#and<%syntax in the source code, which allows minification of many HTML templates written for most engines like Pebble, Mustache, Django, Go, Jinja, Twix, Nunjucks, Handlebars, Sailfish, JSP, EJS, and ERB. Look for thepreserve_*_template_syntaxCfg options.PHP blocks (<?phpor<?=) also happen to be processing instructions, which are preserved by default.Note that in all of these syntax, the parsing is "dumb": it will simply look for the next subsequence of characters that match the closing delimiter. This may cause issues if nesting or string literals appear inside these blocks, but this should be rare.MinificationNote 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_doctypeensure_spec_compliant_unquoted_attribute_valueskeep_spaces_between_attributesWhitespaceminify-html has advanced context-aware whitespace minification that does things such as:Leave whitespace untouched inpreandcode, 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.MethodsThere are three whitespace minification methods. When processing text content, minify-html chooses which ones to use depending on the containing element.Collapse whitespaceApplies to:any element exceptwhitespace sensitiveelements.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 whitespaceApplies to:any element exceptwhitespace sensitive,content,content-first, andformattingelements.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 whitespaceApplies to:any element exceptwhitespace sensitiveandformattingelements.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 typesminify-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.GroupElementsExpected childrenFormattinga,strong,and othersFormatting elements, text.Contenth1,p,and othersFormatting elements, text.Layoutdiv,ul,and othersLayout elements, content elements.Content-firstlabel,li,and othersLike content but could be layout with only one child.Formatting elementsWhitespace 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 elementsWhitespace 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 elementsWhitespace 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 usingdisplay: inline-blockso 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 elementsWhitespace 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>TagsOptional opening and closing tagsare removed.AttributesAny 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 attributevalues are removed.Some other attributesare completely removed if their value is empty or the default value after any processing.typeattributes onscripttags with a value equaling aJavaScript MIME typeare 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 implicitlythe sameas an attribute with an empty string value.Spaces are removed between attributes when possible.EntitiesEntities 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 validUnicode Scalar Valueare replaced with thereplacement 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.CommentsComments are removed.IgnoredBangs,processing instructions, and empty elements are not removed as it is assumed there is a special reason for their declaration.Parsingminify-html can process any HTML, handling all possible syntax (including invalid ones) gracefully like browsers. SeeParsing.mdfor more details.Issues and contributionsPull requests and any contributions welcome!If minify-html did something unexpected, misunderstood some syntax, or incorrectly kept/removed some code,raise an issuewith some relevant code that can be used to reproduce and investigate the issue.