# @chalk-format/core 中文文档

规范地址：https://npmcn.com/package/%40chalk-format/core/

版本：0\.1\.6
npm 元数据更新时间：2026-11-02T20:11:37.097Z
中文译文更新时间：2026-11-09T19:48:27.755Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：459 kB，98 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：3 个
- 首次发布：2026-10-23T10:55:30.700Z
- 最新版本发布：2026-11-02T20:11:36.723Z
- 近 30 天下载量：1768（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

.chark交互式书格式:数据模型,读取并撰写.chark文件,资产键和存储,媒体库,和实验室.

## 安装

```sh
npm install @chalk-format/core
```

也可以使用：`pnpm add @chalk-format/core`、`yarn add @chalk-format/core`、`bun add @chalk-format/core`

## README

# @ chalk-format/core (中文(简体) )

这个 **`.chalk` 交互式图书格式** 用于 JavaScript 和 TypeScript: 数据模型,读取和写入 `.chalk` 文档、资产密钥和商店、媒体库和运行中的实验室.

A 类 `.chalk` 书是页面(制成的 PDF 页面、图像或颜色),上面放有对象:墨水、文字、图像、, 视频,声音,3D模型和实验室,有文本层进行搜索. 媒体由从它的字节所制作的密钥来命名.

```bash
npm i @chalk-format/core
```

```ts
import { unpackLesson, packLesson, assetKey, registryLibrary } from '@chalk-format/core';

const { lesson, assets } = await unpackLesson(bytes);          // open a .chalk
console.log(lesson.title, lesson.pages.length);
const again = await packLesson(lesson, assets);                 // write it back

const key = await assetKey(videoBytes);                         // 'c1:…', the same for the same bytes everywhere
const library = registryLibrary({ url: 'https://library.example.org' });
const found = await library.search({ q: 'pendulum', types: ['video/*'] });
```

实验室跟读者谈话 `@chalk-format/core/lab/client`数字 :

```ts
import { connectLab } from '@chalk-format/core/lab/client';
const lab = await connectLab({ id: 'org.example.pendulum', version: '1.0.0' });
```

相关软件包 : [`@chalk-format/reader`](https://www.npmjs.com/package/@chalk-format/reader) (反应读者和编辑), [`@chalk-format/pdf`](https://www.npmjs.com/package/@chalk-format/pdf) (中文(简体) ) `.chalk`, (中文(简体) ), [`@chalk-format/library-server`](https://www.npmjs.com/package/@chalk-format/library-server) (运行媒体库).

规格、指南和来源: [https://github.com/runagent-dev/calk-format (中文(简体) )](https://github.com/runagent-dev/chalk-format). Apache -2.0 (英语).

## 常见问题

### @chalk-format/core 是什么？

\.chark交互式书格式:数据模型,读取并撰写\.chark文件,资产键和存储,媒体库,和实验室\.

### 如何安装 @chalk-format/core？

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

### @chalk-format/core 支持 TypeScript 吗？

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

### @chalk-format/core 支持 ESM 还是 CommonJS？

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

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

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

### @chalk-format/core 可以商用吗？

@chalk-format/core 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @chalk-format/core 的下载量有多少？

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

### @chalk-format/core 还在维护吗？

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