jitword协同AI文档SDK已开源!轻松接入任何后端!

之前和大家分享了我们精心打磨的协同AI文档 JitWord:

最近很多用户咨询我 JitWord 协同文档集成的问题,希望我们能提供本地可测试的版本,能让他们集成到系统测试体验。

最近我们也加班加点,上线了AI文档的 SDK 版本,大家可以使用 JitWord SDK,轻松集成到自己的系统。

开源地址:github.com/MrXujiang/j...

下面聊聊我们 JitWord SDK 的设计架构。

JitWord SDK 架构设计

jitword SDK 采用微内核架构,核心引擎仅2.3MB,我们采用了三层架构设计:渲染层、协同层、AI能力层;支持 WebSocket 实时通信,CRDT算法解决冲突;内置AI助手,支持智能写作、内容优化、知识问答等。

SDK的实现目标

设计sdk的最终目标还是为了降低企业和开发人员的接入成本,支持通过本地文件引入到项目(后端接口和协同部分需连接远程服务)。具体目标如下:

  • 多技术栈支持支持 Vue, React, Angular, 原生 HTML 等。
  • API 暴露提供丰富的 API 让开发人员控制编辑器行为。
  • 快速上手简单易用,5分钟即可完成接入。
  • 完善文档提供详细的 API 和 SDK 使用文档。

对于API暴露,我们也借鉴了很多用户的建议,最终输出了一份比较完整的API扩展:

  1. 基础配置:
  1. 编辑器配置:
  1. 协同服务配置:
  1. 文档数据处理
  1. 离线模式配置

使用方式也很简单,接下来和大家分享一下。

本地使用指南

1. 初始化编辑器

在 HTML 中准备一个容器:

ini 复制代码
<divid="col-editor" style="height: 100vh;"></div>

使用 Jitword 类初始化:

这样就可以在本地拥有一个完全独立且离线的文档编辑器啦:

详细的配置使用文档,我们在github上提供了完整说明,大家可以体验一下:

开源地址:github.com/MrXujiang/j...

好啦,今天就分享到这,如果大家对AI Word编辑器感兴趣,也欢迎随时和我交流。

相关推荐
子兮曰3 天前
jev-ultrafast 深度解析:7 秒订机票的浏览器 Agent 是如何炼成的
前端·后端·agent
子兮曰3 天前
Jev 爆发一周:7 秒 Agent 背后的 System One 生态与三场争议
前端·后端·ai编程
前端小万3 天前
写公众号赚了 3000 块后,我做了一款叫 "一键成稿" 的软件
前端·微信小程序
爱勇宝3 天前
ZCode 开源 24 小时:一份没有历史的账本,回答不了"有没有偷代码"
前端·后端·chatglm (智谱)
A黄俊辉A3 天前
uniapp webview中实现 app和内嵌的H5双向通信
vue.js·json
三十而立洋3 天前
Cookie 详解:从产生到安全,一次讲透
前端·javascript
卡布鲁3 天前
把一个 Vite + Vue3 应用塞进 qiankun (React + Umi3) 主站:十个坑的复盘
前端·javascript·react.js
honkun63 天前
vue 表格组件 vxe-table 配置 ajax 请求自动加载数据与表单查询
vue.js·vxe-table
lpfasd1233 天前
2026年第38周GitHub趋势周报
python·科技·github
kybs19913 天前
全球灾害数据分析可视化 毕业设计-附源码66794
vue.js·spring boot·mysql·安全·django·c#·asp.net