docx-editor

环境要求

• Node.js 环境（用于 npm 安装）
• 一个支持 ES Module 的现代前端项目或页面
• 页面中预留承载编辑器与工具栏的 DOM 容器

安装与启动步骤

1. 1安装依赖

   在项目根目录执行 npm 安装 superdoc 包，它会作为前端依赖被引入。

   npm install superdoc

   复制

2. 2添加容器元素

   在页面中放置两个容器，分别用于工具栏和编辑器挂载，id 需与后续配置一致。

   复制

3. 3引入样式与类

   在 JS 入口引入 superdoc 的样式文件，并导入 SuperDoc 类。

   import 'superdoc/style.css';
   import { SuperDoc } from 'superdoc';

   复制

4. 4初始化编辑器

   用 selector、toolbar 指定容器，document 传文档地址；省略 document 则以空白 DOCX 启动。

   const superdoc = new SuperDoc({
     selector: '#superdoc',
     toolbar: '#superdoc-toolbar',
     document: '/sample.docx',
     documentMode: 'editing',
   });

   复制

5. 5启动前端项目

   用你项目原有的开发服务器命令启动页面，浏览器打开后即可看到编辑器。

关键配置

如何确认成功

页面加载后指定容器内渲染出 DOCX 编辑器与工具栏，并能显示 /sample.docx 内容。

常见问题

注意事项

• 项目使用 AGPL v3 许可证，商用前需确认授权要求。
• README 只给出前端库用法，未提供后端或 Docker 部署方式。
• 完整配置与进阶用法请查阅官方文档 docs.superdoc.dev。