https://github.com/ntsd/sveltekit-html-minifier

Sveltekit Adapter to Minify the preload HTML page
https://github.com/ntsd/sveltekit-html-minifier

hacktoberfest html-minifier svelte sveltekit sveltekit-adapter

Last synced: about 2 months ago
JSON representation

Sveltekit Adapter to Minify the preload HTML page

• Host: GitHub
• URL: https://github.com/ntsd/sveltekit-html-minifier
• Owner: ntsd
• License: mit
• Created: 2023-08-02T09:42:17.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-10-25T06:14:05.000Z (3 months ago)
• Last Synced: 2024-10-26T17:44:33.258Z (3 months ago)
• Topics: hacktoberfest, html-minifier, svelte, sveltekit, sveltekit-adapter
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/sveltekit-html-minifier
• Size: 92.8 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Sveltekit HTML Minifier

![NPM Version](https://img.shields.io/npm/v/sveltekit-html-minifier) ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/ntsd/sveltekit-html-minifier/test.yaml)

Sveltekit Adapter to Minify the preload HTML page in case using CSR/Preload by [html-minifier-terser](https://github.com/terser/html-minifier-terser).

> [!WARNING]  

> This adaptor will only minify from the `prerendered` HTML output path, If the page is rendering on runtime it will not minify.

For SSR minify @leoj3n had share a solution here https://github.com/ntsd/sveltekit-html-minifier/issues/5

## Installation

`npm i -D sveltekit-html-minifier`

## Usage

Add the adapter to your `svelte.config.js` file. Place your default adapter as the first parameter. This will run after the default adapter has finished rendering.

```js

import adapter from "@sveltejs/adapter-static";

import htmlMinifierAdaptor from "sveltekit-html-minifier";

export default {

  kit: {

    adapter: htmlMinifierAdaptor(adapter()),

  },

};

```

Make sure that the page you want to minify have [`export const prerender = true;`](https://kit.svelte.dev/docs/page-options#prerender) flag set and the output path is correct for the adaptor, otherwise it will not minify.

### Options

You can pass additional options to the adapter. For example

```js

import adapter from "@sveltejs/adapter-static";

import htmlMinifierAdaptor from "sveltekit-html-minifier";

export default {

  kit: {

    adapter: htmlMinifierAdaptor(

      adapter({

        pages: "build",

      }),

      {

        // your build path (same as adapter static pages)

        pages: "build",

        // custom html-minifier-terser options

        // https://github.com/terser/html-minifier-terser#options-quick-reference

        minifierOptions: {},

      }

    ),

  },

};

```

- `pages` (string): Specifies the build path. This should be the same as the adapter static pages.

- `minifierOptions` (object): Custom options for [html-minifier-terser](https://github.com/terser/html-minifier-terser#options-quick-reference).

for other adaptor, you probably need to specify the HTML output path:

`@sveltejs/adapter-cloudflare`

```js

htmlMinifierAdaptor(adapter(), { pages: ".svelte-kit/cloudflare" })

```

`@sveltejs/adapter-vercel`

```js

htmlMinifierAdaptor(adapter(), { pages: ".svelte-kit/output/prerendered/pages" })

```