项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-09-22 · 当前星标 ★ 1128
技术标签
使用教程
环境要求
- Node.js 环境(用于 npm 安装)
- 一个支持 ES Module 的现代前端项目或页面
- 页面中预留承载编辑器与工具栏的 DOM 容器
安装与启动步骤
-
1安装依赖
在项目根目录执行 npm 安装 superdoc 包,它会作为前端依赖被引入。
npm install superdoc -
2添加容器元素
在页面中放置两个容器,分别用于工具栏和编辑器挂载,id 需与后续配置一致。
<div id="superdoc-toolbar"></div> <div id="superdoc"></div> -
3引入样式与类
在 JS 入口引入 superdoc 的样式文件,并导入 SuperDoc 类。
import 'superdoc/style.css'; import { SuperDoc } from 'superdoc'; -
4初始化编辑器
用 selector、toolbar 指定容器,document 传文档地址;省略 document 则以空白 DOCX 启动。
const superdoc = new SuperDoc({ selector: '#superdoc', toolbar: '#superdoc-toolbar', document: '/sample.docx', documentMode: 'editing', }); -
5启动前端项目
用你项目原有的开发服务器命令启动页面,浏览器打开后即可看到编辑器。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
selector | 是 | 编辑器挂载的 DOM 选择器 | #superdoc |
toolbar | 否 | 工具栏挂载的 DOM 选择器 | #superdoc-toolbar |
document | 否 | 文档来源,支持 URL、File 或 Blob;省略则新建空白 DOCX | /sample.docx |
documentMode | 否 | 文档模式,示例为编辑模式 | editing |
如何确认成功
页面加载后指定容器内渲染出 DOCX 编辑器与工具栏,并能显示 /sample.docx 内容。
常见问题
Q:document 支持哪些类型?
A:README 说明支持 URL、File 或 Blob 三种;不传该参数时会以一份空白 DOCX 作为初始文档。
Q:可以不用前端框架吗?
A:可以。SuperDoc 只要求页面提供两个挂载元素,原生 HTML 加模块脚本即可使用;README 另提供 React 快速开始链接。
Q:编辑器挂不上去怎么办?
A:先确认页面上存在 id 为 superdoc 与 superdoc-toolbar 的元素,再检查 selector 和 toolbar 配置是否与这些 id 一致。
注意事项
- 项目使用 AGPL v3 许可证,商用前需确认授权要求。
- README 只给出前端库用法,未提供后端或 Docker 部署方式。
- 完整配置与进阶用法请查阅官方文档 docs.superdoc.dev。
核心亮点
- 提供面向 AI Agent 的 DOCX 操作 SDK,可直接定位段落、插入内容和修改格式,而非只做文本抽取
- 基于 TypeScript 且可在浏览器端运行,便于嵌入现有 Web 应用做在线编辑与协同
- 兼容 MS Word 的 DOCX 格式并支持导出 PDF,贴近真实办公文件流转需求
不足之处
- 项目仍处于成长阶段,API 稳定性和边界场景(复杂样式、宏、嵌入对象)覆盖度有待验证
- 生态与文档相对新,社区案例和第三方集成较少,遇到问题可参考的资料有限
适用场景
- 合同/报告自动生成:AI 按模板填充内容并保留原有 Word 样式后导出
- 在线文档协作编辑:在 Web 应用中嵌入 DOCX 编辑器并支持多人协同
- 文档审阅 Agent:让 AI 读取 Word 批注与修订并自动给出修改建议
替代项目
ONLYOFFICE Document Server、docx、Univer
同类项目推荐
awesome-microsoft-copilot-prompt···
开源
400+条实战提示词,让Copilot在办公场景即拿即用
The definitive Microsoft 365 Copilot prompt library for business teams. 573 prompts ···
ios-lumo
开源
手机上随时查看产品数据,决策快人一步
iOS application for Lumo
preswald
开源
把 Python 数据应用打包成单个 HTML,浏览器里离线跑,分享像发文档。
Preswald is a WASM packager for Python-based interactive data apps: bundle full comp···
MyBrain
开源
一个应用搞定任务、笔记、日历,还有 AI 帮你忙
All-in-one productivity app and AI assistant with Tasks, Notes, Calendar, Diary and ···
MinerU-Skill
开源
把 PDF/Office/图片一键转成 AI 能读的干净 Markdown
AI-Native document parser: PDF, Office & images → clean Markdown with LaTeX, tables···
crumbs
开源
把缩进文本一键变成思维导图,告别手动绘图。
Turn asterisk-indented text lines into mind maps
Noted
开源
开会不用记,边聊边出摘要还能问答
A full-stack real-time transcription app with rolling summaries, topic detection, an···
docxtemplater
开源
用 Word 模板 + JSON 数据,一键生成批量文档
Generate docx, pptx, and xlsx from templates (Word, Powerpoint and Excel documents),···
tocify
开源
给 PDF 加书签目录,扫描件还能 OCR 搜内容
Add PDF bookmarks online and make it searchable by OCR
