@eigenpal/docx-编辑-核心
框架不可知性核心 docx 编辑器。Parses DOCX,构建文档模型,运行ProseMiror,并制作Word-fidity页面。 把反应器和Vue适配器 以及其他你在上面建造的.
快速启动
大多数用户想要 反应 或者说 阴道 适配器. 在构建自定义适配器时直接到达核心,在服务器上运行无头,或者在没有UI的情况下驱动DOCX解析/串行.
npm install @eigenpal/docx-editor-core
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 |  反应适配器. 工具栏 页面编辑器 插件. |
@eigenpal/docx-editor-vue |  Vue 3适配器. 工具栏 页面编辑器 插件. |
@eigenpal/docx-editor-core | 框架-不可知核:OOXML 解析器,序列器,布局引擎,ProseMirror schema. 取决于此, 如果您要叉出反应或 Vue 适配器 . |
@eigenpal/docx-editor-i18n | 两个适配器消耗的共享地块串和类型. |
@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 所以消费者的包裹不会重复:
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/建筑学。 。 。 .
捐款
欢迎捐款。 见 捐款额 用于设置,测试,以及一次性CLA签名.
商业支助
[TIP] 问题还是习惯特征? 电子邮件 docx-编辑器@eigenpal.com。 。 。 .