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

相关推荐
小陈工2 小时前
Python Web开发入门(十七):Vue.js与Python后端集成——让前后端真正“握手言和“
开发语言·前端·javascript·数据库·vue.js·人工智能·python
研究点啥好呢7 小时前
Github热门项目推荐 | 创建你的像素风格!
c++·python·node.js·github·开源软件
xiaotao1317 小时前
第九章:Vite API 参考手册
前端·vite·前端打包
午安~婉7 小时前
Electron桌面应用聊天(续)
前端·javascript·electron
彧翎Pro7 小时前
基于 RO1 noetic 配置 robosense Helios 32(速腾) & xsense mti 300
前端·jvm
小码哥_常8 小时前
解锁系统设置新姿势:Activity嵌入全解析
前端
之歆8 小时前
前端存储方案对比:Cookie-Session-LocalStorage-IndexedDB
前端
哟哟耶耶8 小时前
vue3-单文件组件css功能(:deep,:slotted,:global,useCssModule,v-bind)
前端·javascript·css
是罐装可乐8 小时前
深入理解“句柄(Handle)“:从浏览器安全到文件系统访问
前端·javascript·安全
无限进步_8 小时前
【C++】电话号码的字母组合:从有限处理到通用解法
开发语言·c++·ide·windows·git·github·visual studio