@nuxt-modules/compression

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]

> Assets Compression module for Nuxt 3

- ✨  Release Notes
- 📖  Read the documentation

Features

- Nuxt 3 ready
- Assets Compression using vite-plugin-compression
- Advanced configuration options
- TypeScript support

📖  Read the documentation

Setup

``sh
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.

`javascript
// nuxt.config.js

{
buildModules: [
['@nuxt-modules/compression']
]
}
`

And that's it! Now, the gzip compression will compress your static 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

[npm-version-src]: https://img.shields.io/npm/v/@nuxt-modules/compression/latest.svg
[npm-version-href]: https://npmjs.com/package/@nuxt-modules/compression

[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxt-modules/compression.svg
[npm-downloads-href]: https://npmjs.com/package/@nuxt-modules/compression

[github-actions-ci-src]: https://github.com/nuxt-modules/compression/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/nuxt-modules/compression/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/compression.svg
[codecov-href]: https://codecov.io/gh/nuxt-modules/compression

[license-src]: https://img.shields.io/npm/l/@nuxt-modules/compression.svg
[license-href]: https://npmjs.com/package/@nuxt-modules/compression