# @github/axe-github 中文文档

规范地址：https://npmcn.com/package/%40github/axe-github/

版本：0\.8\.1
npm 元数据更新时间：2026-10-15T16:20:18.542Z
中文译文更新时间：2026-11-16T10:50:46.849Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.5 MB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-01-24T18:20:29.949Z
- 最新版本发布：2025-10-02T16:46:24.156Z
- 近 30 天下载量：149995（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

自定义规则和配置建议 `axe-core` gitHub 项目的库

## 安装

```sh
npm install @github/axe-github
```

也可以使用：`pnpm add @github/axe-github`、`yarn add @github/axe-github`、`bun add @github/axe-github`

## README

# 轴- github

自定义规则和配置建议 `axe-core` gitHub 项目的库.

## 自定义规则

这些是本套件中的自定义规则:

-   `aria-attribute-is-valid`
-   `autofocus-in-dialog`
-   `avoid-both-disabled-and-aria-disabled`
-   `empty-summary`
-   `menuitem-should-be-interactive`
-   `nested-forms`
-   `redundant-aria-label-aria-labelledby`
-   `submit-reset-button-must-be-in-form`

## 配置

我们建议运行 `axe-core` 默认值.

## 基本用途

```JS
import 'axe-core'
import customRules from '@github/axe-github'

axe.configure(customRules)
axe.run(...)
```

### 剧作家配置

对于此库中的自定义规则,其相关的检查功能不能序列到 a [剧作家](https://playwright.dev/) 页 次 要配置轴, 您需要加载和评价 `configure-browser.ts` 在页面上下文中。 Axe 在配置前应该在页面上加载.

```JS
const configSrc = fs.readFileSync(
  require.resolve('@github/axe-github/configure-browser'),
  'utf8'
)

page.evaluate((configSrc) => {
  window.eval(configSrc)
}, configSrc)
```

## 常见问题

### @github/axe-github 是什么？

自定义规则和配置建议 axe-core gitHub 项目的库

### 如何安装 @github/axe-github？

在项目目录运行 npm install @github/axe-github，或使用 pnpm add / yarn add / bun add。

### @github/axe-github 支持 TypeScript 吗？

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

### @github/axe-github 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @github/axe-github 可以商用吗？

@github/axe-github 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @github/axe-github 的下载量有多少？

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

### @github/axe-github 还在维护吗？

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

