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编辑器感兴趣,也欢迎随时和我交流。

相关推荐
小二·16 小时前
Pinia 完全指南:用 TypeScript 构建可维护、可测试、可持久化的 Vue 3 状态管理
javascript·vue.js·typescript
bug总结16 小时前
Vue3 实现后台管理系统跳转大屏自动登录功能
前端·javascript·vue.js
用户479492835691516 小时前
同事一个比喻,让我搞懂了Docker和k8s的核心概念
前端·后端
烛阴16 小时前
C# 正则表达式(5):前瞻/后顾(Lookaround)——零宽断言做“条件校验”和“精确提取”
前端·正则表达式·c#
C_心欲无痕16 小时前
浏览器缓存: IndexDB
前端·数据库·缓存·oracle
郑州光合科技余经理16 小时前
技术架构:上门服务APP海外版源码部署
java·大数据·开发语言·前端·架构·uni-app·php
GIS之路16 小时前
GDAL 实现数据属性查询
前端
PBitW17 小时前
2025,菜鸟的「Vibe Coding」时刻
前端·年终总结
mwq3012318 小时前
不再混淆:导数 (Derivative) 与微分 (Differential) 的本质对决
前端
小二·18 小时前
Vue 3 组件通信全方案详解:Props/Emit、provide/inject、事件总线替代与组合式函数封装
前端·javascript·vue.js