# @darkobits/vite-plugin-favicons 中文文档

规范地址：https://npmcn.com/package/%40darkobits/vite-plugin-favicons/

版本：0\.3\.3
npm 元数据更新时间：2024-12-05T06:24:20.263Z
中文译文更新时间：2026-11-11T11:57:31.924Z
软件包许可：Hippocratic

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40darkobits/vite-plugin-favicons
原文对照：https://npmcn.com/package/%40darkobits/vite-plugin-favicons/?lang=original
项目主页：https://github.com/darkobits/vite-plugin-favicons#readme
源码仓库：https://github.com/darkobits/vite-plugin-favicons

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：71.5 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：10 个
- peer 依赖：vite ^5\.0\.0
- 首次发布：2021-08-21T01:08:48.910Z
- 最新版本发布：2024-12-05T06:24:20.088Z
- 近 30 天下载量：5538（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 0 个）

## 中文简介

为你的Vite项目创造法维孔斯 并用缓冲来加速重建.

## 安装

```sh
npm install @darkobits/vite-plugin-favicons
```

也可以使用：`pnpm add @darkobits/vite-plugin-favicons`、`yarn add @darkobits/vite-plugin-favicons`、`bun add @darkobits/vite-plugin-favicons`

## README

![](https://github.com/darkobits/vite-plugin-favicons/assets/441546/1f4635ba-bc51-4903-8649-5e3a6c97d65d)

[![](https://img.shields.io/npm/v/@darkobits/vite-plugin-favicons.svg?style=flat-square)](https://www.npmjs.com/package/@darkobits/vite-plugin-favicons) [![](https://img.shields.io/github/actions/workflow/status/darkobits/vite-plugin-favicons/ci.yml?style=flat-square)](https://github.com/darkobits/vite-plugin-favicons/actions?query=workflow%3Aci) [![](https://img.shields.io/depfu/darkobits/vite-plugin-favicons?style=flat-square)](https://depfu.com/repos/github/darkobits/vite-plugin-favicons) [![](https://img.shields.io/static/v1?label=commits&message=conventional&style=flat-square&color=398AFB)](https://conventionalcommits.org/) [![](https://img.shields.io/static/v1?label=license&message=hippocratic&style=flat-square&color=753065)](https://firstdonoharm.dev/)

还有一个外观插件 。 @ @ info

## 特征

-   为每个图标类型指定不同的源资产(即: `favicon.png` 以给养, `startup.png` 页:1 苹果启动屏幕等).
-   渲染后的资产被缓存到磁盘上. 重建运行时间为~40m. ~

## 安装

```
npm install --save-dev @darkobits/vite-plugin-favicons
```

## 使用

插件接受一个 [`FaviconOptions`](https://github.com/itgalaxy/favicons#usage) 用于对象 配置 [`favicons`](https://github.com/itgalaxy/favicons),但有下列差异:

```js
import { defineConfig } from 'vite';
import { faviconsPlugin } from '@darkobits/vite-plugin-favicons';

export default defineConfig(() => ({
  plugins: [
    faviconsPlugin({
      /**
       * Whether to inject the HTML fragments generated by `favicons` into the
       * compilation's HTML document.
       *
       * @default `true`
       */
      inject: true,

      /**
       * Whether to cache generated assets for faster rebuilds.
       *
       * @default `true`
       */
      cache: true,

      // Any additional `favicons` configuration options may be used here.

      /**
       * Specify each icon type to render. Unlike `favicons`, this plugin is
       * opt-in, meaning only the icon types you declare here will be rendered.
       *
       * For each icon type, all `favicons` options are supported. An
       * additional `source` property is required to indicate the asset to be
       * used for that icon type.
       */
      icons: {
        favicons: {
          source: './assets/favicon.png'
        },
        android: {
          source: './assets/android.png'
        },
        appleStartup: {
          source: './assets/apple-startup.png'
        }
        // ...etc.
      }
    })
  ]
}));
```

## 上一个艺术

-   [`vite-plugin-favicon`](https://github.com/josh-hemphill/vite-plugin-favicon)
-   [`favicons-webpack-plugin`](https://github.com/jantimon/favicons-webpack-plugin)

  
[![](https://user-images.githubusercontent.com/441546/189774318-67cf3578-f4b4-4dcc-ab5a-c8210fbb6838.png)](https://npmcn.com/package/%40darkobits/vite-plugin-favicons/#readme-top)

## 常见问题

### @darkobits/vite-plugin-favicons 是什么？

为你的Vite项目创造法维孔斯 并用缓冲来加速重建\.

### 如何安装 @darkobits/vite-plugin-favicons？

在项目目录运行 npm install @darkobits/vite-plugin-favicons，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vite（^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @darkobits/vite-plugin-favicons 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @darkobits/vite-plugin-favicons 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @darkobits/vite-plugin-favicons 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @darkobits/vite-plugin-favicons 可以商用吗？

@darkobits/vite-plugin-favicons 使用 Hippocratic 许可。声明的许可为 Hippocratic，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @darkobits/vite-plugin-favicons 的下载量有多少？

根据 npm 官方下载统计，@darkobits/vite-plugin-favicons 在 2026/10/12 – 2026/11/10 这 30 天内被下载 5,538 次，日均约 185 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @darkobits/vite-plugin-favicons 还在维护吗？

最新版本 0\.3\.3 发布于 2024/12/05（1\.9 年前）；至今共发布 19 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/08/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。