@a11ign/documents

中文文档
0.1.2发布于 2026/10/09Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 2369

PDF层(ADR 0036's 第2层,#68):读取一个PDF自己的可访问标记树 -- -- 被标记/未标记,文档语言,数字上的备选案文 -- -- 没有浏览器,没有NVDA和车队.

中文使用文档
文档目录3 节
  1. 它检查什么
  2. 为什么会这样
  3. 在这里工作

@a11ign/documents

PDF 层 (AR 0036 (英语), 第68页. 读取 PDF 本身的可访问性 标签树 直接 - 一个屏幕读取器或者像 PAC 这样的检查器的结构 - 而不是 提供文档或驱动任何辅助技术。 没有浏览器 没有NVDA 没有车队.

import { scanPdfTagTree } from "@a11ign/documents";

const result = await scanPdfTagTree("https://example.com/report.pdf");
if (result.ok) {
  for (const finding of result.findings) {
    console.log(finding.rule, finding.wcag, finding.help);
  }
} else {
  console.error(result.error);
}

looksLikePdfUrl(url) 告诉呼叫者目标是否属于此层, 扩展后, 在 获取的任何东西 -- -- CLI(a11ign)使用它来引导 a .pdf 这里的 URL 而不是租赁 a 屏幕阅读器工人.

它检查什么

三个结构事实 直接从目录和结构元素词典读取 pdf-lib,从未从渲染中推断:

调查结果西非咨询组内容
pdf-untagged1.3.1 国家/MarkInfo /Marked true 财务报告和审定财务报表 /StructTreeRoot 二者不同时存在 -- -- 文件中没有任何一个具有方案确定性的结构
pdf-missing-lang3.1.1 国家目录没有 /Lang
pdf-figure-no-alt1.1.1 (中文(简体) )(单位:千美元) Figure 结构元素(行走) /StructTreeRoot是因为 /K 树)没有 /Alt

pdf-figure-no-alt 当结构元素的 /Pg 决定执行文件之一 页面.

为什么会这样

#68自己的第二层标准是"最廉价的证明[层]合同错误,如果 这是错的,而不是对用户最有用的。" 一个PDF没有DOM,没有实时导航命令,以及 可能连屏幕阅读器和基于规则的地层 假设的“一页”都没有. ceo裁决 # 1131 只从键盘上挑取( 测试模型最少) , 对比/ 视觉( 需要渲染管道) 和认知(几乎完全转诊) 正是因为这个原因.

报告 Report.pdf (单位:千美元)packages/cli/src/report.ts 内 a11ign/a11ign同样的方式,轴-核心报告通过 Report.axe - 一个新领域,从来没有改变到 @a11ign/evidence 或者说 @a11ign/judge形状.

在这里工作

软件包是此寄存器的根 : 1 package.json,一个 README.md (此文件, 也是 npm 页面), 1 LICENSE,没有工作空间文件. pnpm run layout-check 在返回的单列形状上失败( q)@a11ign/toolchain/layout-check),CI运行.

pnpm install --frozen-lockfile
pnpm test         # what the `gate` check runs on every pull request and merge-queue entry
pnpm run smoke    # packs the package and runs it from the tarball, outside this repository

main 通过合并队列只取拉动请求,每个请求都有一个批准审查。 变化应该达到 npm 带有 更改et (pnpm exec changeset),并合并到 main 是释放( e).github/workflows/release.yml· ; .changeset/README.md) (中文(简体) ).

版本与发布记录

@a11ign/documents 共发布 4 个版本,首次发布于 2026/10/04;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.2latest2026/10/0929 天前
0.1.12026/10/061 个月前
0.1.02026/10/041 个月前
0.0.0-reserved.0reserved2026/10/041 个月前

关于 @a11ign/documents 的常见问题

@a11ign/documents 是什么?

PDF层(ADR 0036's 第2层,#68):读取一个PDF自己的可访问标记树 -- -- 被标记/未标记,文档语言,数字上的备选案文 -- -- 没有浏览器,没有NVDA和车队.

如何安装 @a11ign/documents?

在项目目录运行 npm install @a11ign/documents,或使用 pnpm add / yarn add / bun add。

@a11ign/documents 支持 TypeScript 吗?

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

@a11ign/documents 支持 ESM 还是 CommonJS?

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

@a11ign/documents 需要什么版本的 Node.js?

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

@a11ign/documents 可以商用吗?

@a11ign/documents 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@a11ign/documents 的下载量有多少?

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

@a11ign/documents 还在维护吗?

最新版本 0.1.2 发布于 2026/10/09(29 天前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/10/04。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。