Vite Plugin HTML 使用教程

2024-08-20 16:43:09作者：凌朦慧Richard

项目介绍

vite-plugin-html 是一个为 Vite 项目设计的插件，主要用于处理 HTML 文件。它提供了诸如压缩 HTML 内容、注入环境变量等功能，使得开发者可以更灵活地管理和优化前端项目的 HTML 文件。

项目快速启动

安装

首先，你需要在你的 Vite 项目中安装 vite-plugin-html：

npm install vite-plugin-html --save-dev

配置

在你的 Vite 配置文件（通常是 vite.config.js）中引入并配置 vite-plugin-html：

import { defineConfig } from 'vite';
import { createHtmlPlugin } from 'vite-plugin-html';

export default defineConfig({
  plugins: [
    createHtmlPlugin({
      minify: true,
      inject: {
        data: {
          title: 'Vite App',
          injectScript: `<script src="./inject.js"></script>`,
        },
      },
    }),
  ],
});

使用

在 index.html 中，你可以使用插件注入的数据：

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title><%= title %></title>
</head>
<body>
  <div id="app"></div>
  <%= injectScript %>
</body>
</html>

应用案例和最佳实践

案例一：环境变量注入

在开发和生产环境中，你可能需要根据不同的环境变量来注入不同的脚本或数据。vite-plugin-html 可以轻松实现这一点：

createHtmlPlugin({
  inject: {
    data: {
      env: process.env.NODE_ENV,
    },
  },
})

在 HTML 文件中：

<body>
  <div id="app"></div>
  <script>
    console.log('<%= env %>');
  </script>
</body>

案例二：HTML 压缩

在生产环境中，压缩 HTML 文件可以减少文件大小，加快页面加载速度：

createHtmlPlugin({
  minify: true,
})

典型生态项目

vite-plugin-html 通常与其他 Vite 插件和工具一起使用，以构建完整的前端开发环境。以下是一些常见的生态项目：

Vite: 一个快速的前端构建工具。
Vue.js: 一个流行的前端框架，常与 Vite 一起使用。
React: 另一个流行的前端框架，也支持与 Vite 结合使用。

通过结合这些工具和框架，你可以构建出高效、现代的前端应用。

登录后查看全文