Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 2.02 KB

README.md

File metadata and controls

66 lines (41 loc) · 2.02 KB
Raw

⚠️ This module is experimental, try it and let us know how it performs

@nuxtjs/html-minifier

npm (scoped with tag) npm CircleCI

Minify the html for each request served by nuxt server (nuxt start)

ℹ️ nuxt generate already has built-in support for minifying html

🔥 Using this module could be a performance hit 🔥 it is recommended to only use it when you have a caching proxy in front of your Nuxt server (at least until we have benchmarks to determine the real world impact)

Usage

yarn add @nuxtjs/html-minifier OR npm i @nuxtjs/html-minifier

Add @nuxtjs/html-minifier to modules section of nuxt.config.js

{
  modules: [
    ['@nuxtjs/html-minifier', { log: 'once', logHtml: true }]
 ]
}

Options

keepTrying

  • Default: true

If false then every url which generated an error wont be minified in future requests

log

  • Default: always

  • always: always log html-minifier errors

  • once: only log html-minifier errors once for each url

  • false: never log html-minifier errors

logHtml

  • Default: false

Be wary to enable this in production, your disk could fill up quickly!

If true then the html which failed to minimize is also logged

HTML Minifier options

This module uses the build.html.minify property for configuring html minifier

Development

  • Clone this repository
  • Install dependencies using yarn install or npm install
  • Start development server using npm run dev

License

MIT License

Copyright (c) Nuxt Community.