# @gitbook/icons 中文文档

规范地址：https://npmcn.com/package/%40gitbook/icons/

版本：0\.5\.0
npm 元数据更新时间：2026-05-19T11:25:40.616Z
中文译文更新时间：2026-11-16T10:30:14.221Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：1.1 MB，24 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：2 个
- peer 依赖：react \*
- 首次发布：2024-07-30T13:54:15.738Z
- 最新版本发布：2026-05-19T11:25:40.166Z
- 近 30 天下载量：229396（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 8 个）

## 中文简介

GitBook 内容中使用的图标集 .

## 安装

```sh
npm install @gitbook/icons
```

也可以使用：`pnpm add @gitbook/icons`、`yarn add @gitbook/icons`、`bun add @gitbook/icons`

## README

# `@gitbook/icons`

GitBook 内容中使用的图标集 .

## 使用量

```tsx
import { Icon } from '@gitbook/icons';

<Icon name="x" className={'size-5'} />;
```

## 常见问题

### @gitbook/icons 是什么？

GitBook 内容中使用的图标集 \.

### 如何安装 @gitbook/icons？

在项目目录运行 npm install @gitbook/icons，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 gitbook-icons，可以用 npx gitbook-icons 直接运行。

### @gitbook/icons 支持 TypeScript 吗？

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

### @gitbook/icons 支持 ESM 还是 CommonJS？

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

### @gitbook/icons 需要什么版本的 Node\.js？

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

### @gitbook/icons 可以商用吗？

@gitbook/icons 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @gitbook/icons 的下载量有多少？

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

### @gitbook/icons 还在维护吗？

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

