# @dotkey/core 中文文档

规范地址：https://npmcn.com/package/%40dotkey/core/

版本：0\.1\.0
npm 元数据更新时间：2026-08-07T03:57:34.110Z
中文译文更新时间：2026-11-12T19:45:21.499Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.7 MB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：2 个
- 首次发布：2026-08-07T03:57:33.259Z
- 最新版本发布：2026-08-07T03:57:33.668Z
- 近 30 天下载量：5931（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

阅读 Apple 基调 (. key) 文件. 将 iWork 格式分析为渲染器-不可知JSON 文档模型.

## 安装

```sh
npm install @dotkey/core
```

也可以使用：`pnpm add @dotkey/core`、`yarn add @dotkey/core`、`bun add @dotkey/core`

## README

# @ dotkey/ 核心

读取苹果主题`.key`)档案. 将 iWork 格式分析为 a 渲染-不可知JSON文档模型.

```bash
npm i @dotkey/core
```

```ts
import { parseKeynote } from '@dotkey/core';

const doc = await parseKeynote(await file.arrayBuffer());

doc.deck.size;                 // { width: 1920, height: 1080 }
doc.deck.slides[0].elements;   // z-ordered element tree
doc.deck.slides[0].plainText;  // for search, outlines, accessibility
doc.deck.slides[0].builds;     // object animations, each with a click stage
doc.resourceUrl('8073');       // blob: URL for slide media
```

Isomorphic)——浏览器,节点,德诺,邦和工人. 没有反应,没有 `node:` 进口。 两个依赖关系: `fflate` 财务报告和审定财务报表 `protobufjs`。 。 。 .

## 入境点

|  |  |
| --- | --- |
| `@dotkey/core` | 解析和文档模式 |
| `@dotkey/core/node` | `readKeynoteFile()`,它也接受扩展 `.key` 目录 |
| `@dotkey/core/fonts` | 匹配甲板的字体与可装入的网页字体 |

里面的东西 `deck` 是普通的JSON:没有原生出、没有对象引用、没有 二进制. 它活下来了 `JSON.parse(JSON.stringify(…))` 来回旅行,所以可以 在服务器上生产, 缓存, 并任何地方提供.

在反应中画它,看 [`@dotkey/react`](https://www.npmjs.com/package/@dotkey/react)。 。 。 . 完整文档载于 [仓库读取器](https://github.com/1st1/dotkey#readme)。 。 。 .

麻省理工学院. 主旨,iWork和Apple是苹果公司的商标;这个项目不是 隶属于苹果公司.

## 常见问题

### @dotkey/core 是什么？

阅读 Apple 基调 \(\. key\) 文件\. 将 iWork 格式分析为渲染器-不可知JSON 文档模型\.

### 如何安装 @dotkey/core？

在项目目录运行 npm install @dotkey/core，或使用 pnpm add / yarn add / bun add。

### @dotkey/core 支持 TypeScript 吗？

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

### @dotkey/core 支持 ESM 还是 CommonJS？

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

### @dotkey/core 需要什么版本的 Node\.js？

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

### @dotkey/core 可以商用吗？

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

### @dotkey/core 的下载量有多少？

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

### @dotkey/core 还在维护吗？

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