astro-compressor

astro-compressor

A gzip and brotli compressor for Astro

• Simple: Set it and forget it
• Optimal: By compressing ahead of time, a more performant compression can be performed

Table of Contents

Table of Contents

• Quickstart
• NOTE
• Usage
• License

NOTE

Important: It is vital that this is the last integration in the integrations property. Otherwise some files might not get compressed.

Quickstart

Install via your tool of choice:

# Using NPM
npm run astro add astro-compressor
# Using Yarn
yarn astro add astro-compressor
# Using PNPM
pnpm astro add astro-compressor

Then, restart the dev server by typing CTRL-C and then npm run dev in the terminal window that was running Astro.

Usage

First, install the package with your favorite package manager: pnpm add --dev astro-compressor, then configure it in your astro.config.* file in the integrations property:

import { defineConfig } from "astro/config";
import compressor from "astro-compressor";

export default defineConfig({
  // ...
  integrations: [..., compressor()],
});

License

MIT.

Changelog

v0.1.3

2022-12-27

Summary

Update dependencies, fix some CI steps.

Commits

• [28b0d90] Fix release CI step
• [acc0b18] Update dependencies, fix formatting
• [8a64bff] Add publish step on CI pipeline