Baroshem/compression

🗜 Compression module for Nuxt 3

★ 32Forks 0TypeScriptGitHub ↗Compare

Project website ↗

compressionmodulenuxtperformance

README

@nuxt-modules/compression

@nuxt-modules/compression

npm version npm downloads Github Actions CI Codecov License

Assets Compression module for Nuxt 3

Features

📖  Read the documentation

Setup

yarn add @nuxt-modules/compression # yarn
npm i @nuxt-modules/compression # npm

Basic usage

Firstly, you need to add @nuxt-modules/compression to your Nuxt config.

// nuxt.config.js

{
  buildModules: [
    ['@nuxt-modules/compression', {
      algorithm: 'brotliCompress'
    }]
  ]
}

And that's it! Now, the brotli compression will compress your assets. For more configuration options (like brotli compression, filter assets, etc) please, visit the official docs.

Development

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using yarn dev or npm run dev

License

MIT License

Contributors

Baroshem

Issues