# @adobe/helix-importer 中文文档

规范地址：https://npmcn.com/package/%40adobe/helix-importer/

版本：3\.4\.158
npm 元数据更新时间：2026-10-18T18:18:00.287Z
中文译文更新时间：2026-11-06T16:40:13.421Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：373 kB，98 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：13 个
- 首次发布：2022-01-19T15:44:52.286Z
- 最新版本发布：2026-10-18T18:17:59.957Z
- 近 30 天下载量：2724（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：293（近 12 个月 38 个）

## 中文简介

Helix 导入工具: 从 html 创建 md / docx

## 安装

```sh
npm install @adobe/helix-importer
```

也可以使用：`pnpm add @adobe/helix-importer`、`yarn add @adobe/helix-importer`、`bun add @adobe/helix-importer`

## README

# 螺旋导入器

将网站内容输入到一个Helix项目中可以消费的基建工具.

进口商的基本概念:对于输入url,将DOM转换为Markdown / docx文件.

## 导入器

进口商必须延伸 [页面导入器](https://npmcn.com/package/%40adobe/helix-importer/src/importer/PageImporter.js) 执行 `fetch` 财务报告和审定财务报表 `process` 方法。 总的想法是 `fetch` 接收url以导入,并负责返回 HTML. `process` 接收相应的文档,以便在由Markdown变压器处理之前过滤 / 重排 / 重排 DOM . `process` 计算并定义 [页面导入资源](https://npmcn.com/package/%40adobe/helix-importer/src/importer/PageImporterResource.ts) (可能不止一个),每个资源被转换为Markdown文档.

进口商的目标是清除一般的 DOM 元素,如页眉/页脚,导航等,以及所有页面通用的所有元素,以获得每页内容的独特块.

### HTML2x 帮助

[HTML2x 密码](https://npmcn.com/package/%40adobe/helix-importer/src/importer/HTML2x.js) 方法(单位:千美元)`HTML2md` 财务报告和审定财务报表 `HTML2docx`)是运行导入的方便方法。 作为投入,它们采取:

-   `URL`: 要导入的页面的 URL
-   `document`: 导入的 DOM 元素 - 文档对象或字符串(参见 `createDocumentFromString` 用于字符串大小写)
-   `transformerCfg`: 带有变换"规则"的对象. 对象可以是:
    -   `{ transformDOM: ({ url, document, html, params }) => { ... return element-to-convert }, generateDocumentPath: ({ url, document, html, params }) => { ... return path-to-target; }}` 在一个输入文档/一个输出文件之间进行单一映射
    -   `{ transform: ({ url, document, html, params }) => { ... return [{ element: first-element-to-convert, path: first-path-to-target }, ...] }` 用于映射一个输入文档/多个输出文件(用于从一个单一网页生成多个 docx)
-   `config`: 具有多个配置属性的对象
    -   `createDocumentFromString`: 如果您在非浏览器上下文中使用这些方法并想要通过, 则需要此配置 `document` 参数为字符串。 这种方法接收 HTML 作为字符串解析,必须返回文档对象.
    -   `setBackgroundImagesFromCSS`: 设置为假以禁用 `background-image` {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}在DOM里装入内衣.

### 导入器 UI

Helix 导入器有专用浏览器 UI: 见 [https://github.com/adobe/helix-importer-ui 页面存档备份,存于互联网档案馆](https://github.com/adobe/helix-importer-ui)

## 安装

```shell
npm i https://github.com/adobe/helix-importer 
```

TODO: 发布 npm 模块

## 使用量

```js
import { ... } from '@adobe/helix-importer';
```

## 常见问题

### @adobe/helix-importer 是什么？

Helix 导入工具: 从 html 创建 md / docx

### 如何安装 @adobe/helix-importer？

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

### @adobe/helix-importer 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/adobe\_\_helix-importer 是否存在。

### @adobe/helix-importer 支持 ESM 还是 CommonJS？

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

### @adobe/helix-importer 可以商用吗？

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

### @adobe/helix-importer 的下载量有多少？

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

### @adobe/helix-importer 还在维护吗？

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