vitepress-payload-extractor

Extracting duplicate payloads of meta information after vitepress wrapping

This project has been blocked, because the vitepress 1.0.0-beta.6 Supported metaChunk option

README 🦉

简体中文 | English

Motivation

Our team was using vitepress to build large project documents, but as the number of documents grew, the meta information payload of html pages became oversized, so I made this tool that extracts the duplicate payload of pages and reduces the size of the package.

With it, our team's production documents went from 255MB to 94.4MB, which is 37% of the original size. If you are in the same dilemma, maybe you can try this tool!

Usage

install

npm i vitepress-payload-extractor -D

Configuration

Introduce the package in your vitepress configuration file

optimizeHtml

Extract duplicate meta information payloads during vitepress packaging and compress html.

import { defineConfig } from "vitepress";
import { optimizeHtml } from "vitepress-payload-extractor";

export default defineConfig({
  transformHtml(code) {
    return optimizeHtml(code);
  },
});

payloadExtraction

Extract duplicate meta-message payloads during vitepress packaging process

// .vitepress/config.js
import { defineConfig } from "vitepress";
import { payloadExtraction } from "vitepress-payload-extractor";

export default defineConfig({
  transformHtml(code, _, ctx) {
    return payloadExtraction(code, ctx.siteConfig.outDir);
  },
});

minifyHtml

Compresses html and is compatible with vitepress

import { defineConfig } from "vitepress";
import { minifyHtml } from "vitepress-payload-extractor";

export default defineConfig({
  transformHtml(code) {
    return minifyHtml(code);
  },
});

Inspiration

• DreaMinder · nuxt-payload-extractor
• nuxt · issue · Payload extraction support

License

Made with markthree

Published under MIT License.