README.zh-CN.md

VitePress-Plugin-Compression

打包 build 文件夹的 VitePress 插件。官方文档

English | 简体中文

安装

# npm
npm i -D vitepress-plugin-compression

# yarn
yarn add -D vitepress-plugin-compression

# pnpm
pnpm add -D vitepress-plugin-compression

使用

// .vitepress/config.js
import { defineConfig } from "vitepress";
import compression from "vitepress-plugin-compression";

export default defineConfig({
  async buildEnd() {
    compression();
  },
});

选项

export interface Options {
  /**
   * 输入目录
   * @default `dist`
   */
  inDir?: string;
  /**
   * 输出目录
   * @default `dist`
   */
  outDir?: string;
  /**
   * 打包名称
   * @default `dist`
   */
  outFileName?: string;
  /**
   * 打包类型
   * @default `zip`
   */
  type?: "7z" | "zip" | "lzma" | "cab" | "gzip" | "bzip2" | "tar";
}

许可

MIT, 查看许可文件