# @elastic/eui-docusaurus-theme 中文文档

规范地址：https://npmcn.com/package/%40elastic/eui-docusaurus-theme/

版本：2\.9\.0
npm 元数据更新时间：2026-11-16T18:24:09.476Z
中文译文更新时间：2026-11-16T18:30:45.307Z
软件包许可：SEE LICENSE IN LICENSE\.txt

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

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

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

- 包体积（解压后）：679 kB，315 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：17 个
- peer 依赖：react ^18\.0\.0，react-dom ^18\.0\.0
- 首次发布：2025-11-18T12:10:13.153Z
- 最新版本发布：2026-11-16T18:24:09.126Z
- 近 30 天下载量：4914（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：159（近 12 个月 159 个）

## 中文简介

Docusaurus 的 EUI 主题

## 安装

```sh
npm install @elastic/eui-docusaurus-theme
```

也可以使用：`pnpm add @elastic/eui-docusaurus-theme`、`yarn add @elastic/eui-docusaurus-theme`、`bun add @elastic/eui-docusaurus-theme`

## README

# `@elastic/eui-docusaurus-theme`

EUI 自定义 [多龙](https://docusaurus.io/) 为欧盟倡议制定的主题 [文档网站](https://eui.elastic.co/)。 。 。 .

## 使用量

EUI主题使用 [扫地取地](https://docusaurus.io/docs/swizzling/) 将主题组件切换为 包含 EUI 组件和符号的自定义执行.

### 先决条件

在开始安装预设之前, 更新您的 Docusaurus 设置以兼容 与 `@elastic/eui-docusaurus-theme`数字 :

1.  安装所需的软件包
    
    ```shell
    yarn add @emotion/react @emotion/css @elastic/charts
    ```
    
2.  配置类型脚本
    
    您需要添加 `jsxImportSource` 财务报告和审定财务报表 `moduleResolution` 到您的项目 `tsconfig.json`数字 :
    
    ```diff
    {
        // This file is not used in compilation. It is here just for a nice editor experience.
        "extends": "@docusaurus/tsconfig",
        "compilerOptions": {
            "baseUrl": ".",
    +        "jsxImportSource": "@emotion/react",
    +        "moduleResolution": "nodenext"
        }
    }
    ```
    
3.  配置贝贝
    
    添加 `@babel/preset-react` 让情感处理 `importSource`。 。 。 .
    
    ```diff
    module.exports = {
        presets: [
            require.resolve('@docusaurus/core/lib/babel/preset'),
    +       [
    +            '@babel/preset-react',
    +            { runtime: 'automatic', importSource: '@emotion/react' },
    +       ],
        ],
    };
    ```
    

### 安装预设( 建议)

```shell
# npm
npm install @elastic/eui-docusaurus-preset @elastic/eui-docusaurus-theme

# pnpm
pnpm add @elastic/eui-docusaurus-preset @elastic/eui-docusaurus-theme

# Yarn
yarn add @elastic/eui-docusaurus-preset @elastic/eui-docusaurus-theme
```

和在你的 `docusaurus.config.ts` 文件,添加:

```ts
const config: Config = {
    // ...
    presets: [
        require.resolve('@elastic/eui-docusaurus-preset'),
        // ...
    ],
    // ...
}
```

### 仅主题

Docusaurus 使用它的默认 CSS 框架 Infima 来样式化经典主题(`@docusaurus/theme-classic`) (中文(简体) ). EUI Docuraurus主题基于经典主题,但Infima的全局风格往往会压倒或与EUI的设计系统相冲突,导致外观不一致. 这个 `ignore-styles-plugin` 禁用Infima的样式,确保EUI主题显示正确. 为此,我们强烈建议使用预设而不是独立的主题.

如果您喜欢只使用主题, 请安装软件包 :

```shell
# npm
npm install @elastic/eui-docusaurus-theme

# pnpm
pnpm add @elastic/eui-docusaurus-theme

# Yarn
yarn add @elastic/eui-docusaurus-theme
```

和在你的 `docusaurus.config.ts` 文件,添加:

```ts
const config: Config = {
    // ...
    themes: [
        require.resolve('@docusaurus/theme-classic'), // Required for compatibility
        require.resolve('@elastic/eui-docusaurus-theme'),
    ],
    // ...
}
```

## 特征

### 右侧导航链接

实现与该平台类似的右侧导航链接 [EUI 文件](https://eui.elastic.co/),必须使用 `component` 属性,其值为 `"changelog" | "github" | "figma"`。 。 。 .

```ts
themeConfig: {
    // ...
    navbar: {
      // ...
      items: [
        // ...
        // Use component: "changelog" | "github" | "figma"
        {
          href: "https://github.com/elastic/eui/tree/main/packages/eui/changelogs",
          label: "EUI Changelog",
          position: "right",
          component: "changelog",
        },
        {
          href: "https://github.com/elastic/eui",
          label: "GitHub",
          position: "right",
          component: "github",
        },
        {
          href: "https://www.figma.com/community/file/964536385682658129",
          label: "Figma",
          position: "right",
          component: "figma",
        },
      ],
    },
    // ...
}
```

## 地方发展

### 先决条件

此软件包需要:

-   节点.js( 请检查当前版本 : [.nvmrc (英语)](https://npmcn.com/package/.nvmrc), (中文(简体) ),
-   [核心软件包](https://nodejs.org/api/corepack.html)。 。 。 .

### 安装依赖关系

通过运行安装依赖性 :

```shell
yarn
```

### 构建软件包

```shell
yarn build
```

### 以监视模式构建

编辑文件时运行以下命令来构建此软件包:

```shell
yarn start
```

\* 警告 请注意,这个软件包的配置是为了进行增量构建,有时是 `tsc` 可能不会更新 `lib` 如果重命名或删除文件,则带有最新修改的目录.

如果是这样,请跑 `yarn build`。 。 。 . \* :

### EUI 文档网站测试

从单存储器根部运行以下命令以运行网站 :

```shell
yarn workspace @elastic/eui-website start
```

您可以在修改 Docusaurus 主题时将其与表模式相配 .

### 本地测试您自己的 Docusaurus 项目

你应该有一个 Docuraurus 项目运行。 如果您想用新项目测试 EUI 主题, 您应该创建 [Docusaurus 脚手架项目网站](https://docusaurus.io/docs/installation)。 。 。 .

运行以下命令以创建 Docusaurus 项目 :

```shell
npx create-docusaurus@latest my-website classic --typescript
```

在 root 中,运行下列命令来构建和包装本地预设和主题:

```shell
# Build packages
yarn workspace @elastic/eui-docusaurus-theme build
yarn workspace @elastic/eui-docusaurus-preset build

# Pack packages
cd packages/docusaurus-theme
yarn pack --filename docusaurus-theme.tgz

cd ../docusaurus-preset
yarn pack --filename docusaurus-preset.tgz
```

在您的工程中, 安装 EUI 依赖 :

```shell
# npm
npm install @elastic/eui @elastic/charts @emotion/react @emotion/css moment

# pnpm
pnpm add @elastic/eui @elastic/charts @emotion/react @emotion/css moment

# Yarn
yarn add @elastic/eui @elastic/charts @emotion/react @emotion/css moment
```

并添加本地包装包 :

```shell
# npm
npm install /path/to/eui/packages/docusaurus-preset/docusaurus-preset.tgz /path/to/eui/packages/docusaurus-theme/docusaurus-theme.tgz

# pnpm
pnpm add /path/to/eui/packages/docusaurus-preset/docusaurus-preset.tgz /path/to/eui/packages/docusaurus-theme/docusaurus-theme.tgz

# Yarn
yarn add /path/to/eui/packages/docusaurus-preset/docusaurus-preset.tgz /path/to/eui/packages/docusaurus-theme/docusaurus-theme.tgz
```

配置 Docuraurus 以使用 [使用部分](https://npmcn.com/package/%40elastic/eui-docusaurus-theme/#readme-usage)。 。 。 .

#### 作出改变

当修改预设或主题时,重建并重新包装套件.

然后在您的项目中重新安装软件包以更新更改 .

重新启动您的 Docusaurus 开发服务器 :

```shell
# npm
npm run start

# pnpm
pnpm start

# Yarn
yarn start
```

## 常见问题

### @elastic/eui-docusaurus-theme 是什么？

Docusaurus 的 EUI 主题

### 如何安装 @elastic/eui-docusaurus-theme？

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

### @elastic/eui-docusaurus-theme 支持 TypeScript 吗？

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

### @elastic/eui-docusaurus-theme 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @elastic/eui-docusaurus-theme 可以商用吗？

@elastic/eui-docusaurus-theme 使用 SEE LICENSE IN LICENSE\.txt 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @elastic/eui-docusaurus-theme 的下载量有多少？

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

### @elastic/eui-docusaurus-theme 还在维护吗？

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

