# @eigenpal/docx-editor-core 中文文档 规范地址：https://npmcn.com/package/%40eigenpal/docx-editor-core/ 版本：1\.9\.0 npm 元数据更新时间：2026-06-29T21:04:25.237Z 中文译文更新时间：2026-11-13T09:37:40.347Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40eigenpal/docx-editor-core 原文对照：https://npmcn.com/package/%40eigenpal/docx-editor-core/?lang=original 项目主页：https://docx-editor.dev/ 源码仓库：https://github.com/eigenpal/docx-editor 弃用说明：deprecated ## 关键信息（来自 npm 元数据） - 包体积（解压后）：3.5 MB，517 个文件 - 模块格式：ESM + CJS - TypeScript 类型：包内自带 - 运行依赖：5 个 - peer 依赖：prosemirror-view ^1\.32\.7，prosemirror-model ^1\.19\.4，prosemirror-state ^1\.4\.3，prosemirror-keymap ^1\.2\.2，prosemirror-tables ^1\.8\.5，prosemirror-history ^1\.5\.0，prosemirror-commands ^1\.5\.2，prosemirror-transform ^1\.12\.0，prosemirror-dropcursor ^1\.8\.2 - 首次发布：2026-05-19T10:09:02.313Z - 最新版本发布：2026-06-21T15:55:17.074Z - 近 30 天下载量：213210（2026-10-13 至 2026-11-11，npm 官方下载统计） - 已发布版本数：23（近 12 个月 23 个） ## 中文简介 DOCX 解析、编辑和渲染的框架不可知性核心 ## 安装 ```sh npm install @eigenpal/docx-editor-core ``` 也可以使用：`pnpm add @eigenpal/docx-editor-core`、`yarn add @eigenpal/docx-editor-core`、`bun add @eigenpal/docx-editor-core` ## README [![DOCX Editor — .docx in, .docx out. Open source, agent ready, client-side.](https://raw.githubusercontent.com/eigenpal/docx-editor/main/.github/assets/header.png)](https://www.docx-editor.dev/) [![npm version](https://img.shields.io/npm/v/@eigenpal/docx-editor-core.svg?style=flat-square&color=3B5BDB)](https://www.npmjs.com/package/@eigenpal/docx-editor-core) [![npm downloads](https://img.shields.io/npm/dm/@eigenpal/docx-editor-core.svg?style=flat-square&color=3B5BDB)](https://www.npmjs.com/package/@eigenpal/docx-editor-core) [![license](https://img.shields.io/badge/license-Apache_2.0-blue.svg?style=flat-square&color=3B5BDB)](https://github.com/eigenpal/docx-editor/blob/main/LICENSE) [![Demo](https://img.shields.io/badge/Live_Demo-3B5BDB?style=flat-square&logo=vercel&logoColor=white)](https://docx-editor.dev/editor) [![Documentation](https://img.shields.io/badge/Docs-3B5BDB?style=flat-square&logo=readthedocs&logoColor=white)](https://www.docx-editor.dev/docs) # @eigenpal/docx-编辑-核心 框架不可知性核心 [docx 编辑器](https://docx-editor.dev/)。Parses DOCX,构建文档模型,运行ProseMiror,并制作Word-fidity页面。 把反应器和Vue适配器 以及其他你在上面建造的. ## 快速启动 大多数用户想要 [反应](https://www.npmjs.com/package/@eigenpal/docx-editor-react) 或者说 [阴道](https://www.npmjs.com/package/@eigenpal/docx-editor-vue) 适配器. 在构建自定义适配器时直接到达核心,在服务器上运行无头,或者在没有UI的情况下驱动DOCX解析/串行. ```bash npm install @eigenpal/docx-editor-core ``` ```ts import { readFile } from 'node:fs/promises'; import { parseDocx } from '@eigenpal/docx-editor-core/docx'; const buffer = await readFile('contract.docx'); const document = await parseDocx(buffer); console.log(document.paragraphs.length); ``` 每个亚道树摇晃独立. 选择最小的切入点 给你所需要的. ## 软件包 | 软件包 | 说明 | | --- | --- | | [`@eigenpal/docx-editor-react`](https://www.npmjs.com/package/@eigenpal/docx-editor-react) | ![](https://cdn.simpleicons.org/react/61DAFB)   反应适配器. 工具栏 页面编辑器 插件. | | [`@eigenpal/docx-editor-vue`](https://www.npmjs.com/package/@eigenpal/docx-editor-vue) | ![](https://cdn.simpleicons.org/vuedotjs/4FC08D)   Vue 3适配器. 工具栏 页面编辑器 插件. | | [`@eigenpal/docx-editor-core`](https://www.npmjs.com/package/@eigenpal/docx-editor-core) | 框架-不可知核:OOXML 解析器,序列器,布局引擎,ProseMirror schema. 取决于此, 如果您要叉出反应或 Vue 适配器 . | | [`@eigenpal/docx-editor-i18n`](https://www.npmjs.com/package/@eigenpal/docx-editor-i18n) | 两个适配器消耗的共享地块串和类型. | | [`@eigenpal/docx-editor-agents`](https://www.npmjs.com/package/@eigenpal/docx-editor-agents) | 代理SDK和聊天UI:框架-不可知桥,MCP服务器,AI SDK适配器,外加React UI. | > **伪造适配器?** 取出叉子细. 取决于 `@eigenpal/docx-editor-core` 直接如此解析器,序列器, 和渲染自动修复您的建筑中的地块, 不回转每个上游变化的手. ## 子路径图 | 楼... | 从 | 你得到的东西 | | --- | --- | --- | | 一个新的框架适配器 | `./docx`, (中文(简体) ), `./prosemirror/conversion`, (中文(简体) ), `./prosemirror/extensions` | `parseDocx`, (中文(简体) ), `toProseDoc` 编号 : `fromProseDoc`, (中文(简体) ), `createStarterKit`, (中文(简体) ), `ExtensionManager` | | 自定义布局/ 渲染 | `./layout-engine`, (中文(简体) ), `./layout-bridge`, (中文(简体) ), `./layout-painter` | `layoutDocument`, (中文(简体) ), `mouseToPosition`, (中文(简体) ), `renderPage`, (中文(简体) ), `LayoutPainter` | | 编辑器命令和插件 | `./prosemirror/commands`, (中文(简体) ), `./prosemirror/plugins` | 格式化、表格、建议模式、选择跟踪器 | | 保存到 `.docx` | `./docx` | `repackDocx`, (中文(简体) ), `attemptSelectiveSave` | | 无头代理( 无UI) | `./agent` | `DocumentAgent`, (中文(简体) ), `executeCommand`, (中文(简体) ), `AgentCommand` 类型 | | MCP 服务器 | `./mcp` | 模拟上下文协议服务器脚手架 | | 只有单位/ 颜色/ 剪贴板帮助器 | `./utils` | `twipsToPixels`, (中文(简体) ), `resolveColor`、字体加载、剪贴板、选择助手 | | 只是一个类型 | `./types/document`, (中文(简体) ), `./types/content`, (中文(简体) ), `./types/agentApi` | `Document`, (中文(简体) ), `Paragraph`, (中文(简体) ), `Comment`, (中文(简体) ), `AgentCommand`,, , , , , , , , . | | 默认编辑器样式表 | `./prosemirror/editor.css` | 在您的应用程序上方导入一次 | ## 稳定 `./layout-engine`, (中文(简体) ), `./layout-painter`, (中文(简体) ), `./layout-bridge`,以及 `./plugin-api` 为: **`@experimental`** ——被第一方适配器使用,但API可能会改变小放出量,直到第三方适配器验证. 键入一个版本范围 。 其他一切都跟随SemVer. ## 同伴依赖关系 ProseMiror 软件包被宣布为 `peerDependencies` 所以消费者的包裹不会重复: ```bash npm i prosemirror-commands prosemirror-dropcursor prosemirror-history \ prosemirror-keymap prosemirror-model prosemirror-state \ prosemirror-tables prosemirror-transform prosemirror-view ``` ## 建筑 双还原:隐藏的ProseMiror 实例拥有编辑状态( 选择、 撤销/ 重写、 命令) `layout-painter` 生成可见的页面。 全部细分 : **[docx-editor.dev/docs/建筑学](https://www.docx-editor.dev/docs/architecture)**。 。 。 . ## 捐款 欢迎捐款。 见 [捐款额](https://github.com/eigenpal/docx-editor/blob/main/CONTRIBUTING.md) 用于设置,测试,以及一次性CLA签名. ## 商业支助 > \[TIP\] 问题还是习惯特征? 电子邮件 **[docx-编辑器@eigenpal.com](mailto:docx-editor@eigenpal.com)**。 。 。 . ## 常见问题 ### @eigenpal/docx-editor-core 是什么？ DOCX 解析、编辑和渲染的框架不可知性核心注意：该包已被作者标记为弃用——deprecated ### 如何安装 @eigenpal/docx-editor-core？ 在项目目录运行 npm install @eigenpal/docx-editor-core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：prosemirror-view（^1\.32\.7）、prosemirror-model（^1\.19\.4）、prosemirror-state（^1\.4\.3）、prosemirror-keymap（^1\.2\.2）、prosemirror-tables（^1\.8\.5）、prosemirror-history（^1\.5\.0）、prosemirror-commands（^1\.5\.2）、prosemirror-transform（^1\.12\.0）、prosemirror-dropcursor（^1\.8\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 docx-editor-mcp，可以用 npx docx-editor-mcp 直接运行。 ### @eigenpal/docx-editor-core 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @eigenpal/docx-editor-core 支持 ESM 还是 CommonJS？ 同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。 ### @eigenpal/docx-editor-core 可以商用吗？ @eigenpal/docx-editor-core 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。 ### @eigenpal/docx-editor-core 的下载量有多少？ 根据 npm 官方下载统计，@eigenpal/docx-editor-core 在 2026/10/13 – 2026/11/11 这 30 天内被下载 213,210 次，日均约 7,107 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @eigenpal/docx-editor-core 还在维护吗？ 最新版本 1\.9\.0 发布于 2026/06/21（4 个月前）；至今共发布 23 个版本，其中过去 12 个月发布了 23 个；首次发布于 2026/05/19。作者已将其标记为弃用，新项目建议寻找替代方案。