更新 CKEditor 5
本指南涵盖了如何保持 CKEditor 5 版本最新的主题。如果你想从 CKEditor 4 升级到 CKEditor 5,请参阅从 CKEditor 4 迁移指南。
# 更新编辑器
CKEditor 5 通过多种方式交付,其中最灵活、最受欢迎的方式是使用 npm 包。更新过程很简单,只需根据安装方法下载新包或更新 package.json
文件中的包版本。
在进行更新之前,强烈建议您阅读最新版本的变更日志,了解此版本引入的所有更改。您尤其需要注意任何可能出现的重大更改。如果您开发了自己的自定义功能并修改了编辑器,此步骤至关重要,因为有时我们代码中的更改可能会影响这些自定义解决方案。
为了帮助您顺利更新,我们准备了迁移指南,其中描述了在迁移到生产环境之前需要进行的调整。您可以在页面左侧找到它们。
请务必在将更改部署到生产环境之前测试您的编辑器。这将有助于确保更新不会对您的应用程序和用户体验产生负面影响。
您可以简单地访问我们的CKEditor 5 下载页面或构建器,从那里获取最新的编辑器版本。但是,如果您创建了自己的自定义编辑器,则该过程可以简化为以下几个步骤
- 阅读变更日志。
- 更新您的包。
- 阅读迁移指南。
- 重新安装包并重新构建编辑器。
- 测试您的编辑器。
下面是一个示例,它将引导您完成更新过程,并让您了解如何进行更新。
# 示例
假设您使用的是旧版本编辑器,并且想要将其更新到当前的 43.3.0 版本。
第一步是确定自旧版本以来引入的更改,因此您导航到更新指南(位于左侧)以识别旧版本和当前版本之间可能出现的重大更改。这些指南将引导您完成任何必要的代码更改。
建议定期更新。但是,有时您可能会跳过几个版本,需要更新到非相邻版本。在这种情况下,请务必验证所有缺失版本的变更日志和迁移指南,而不仅仅是您要更新到的版本。
当您已经知道发生了哪些更改以及需要调整自定义代码的哪些部分时,就可以进行更新了。
这可以通过使用最新编辑器版本(当前为 43.3.0)更新 package.json
文件或使用某些自动化工具(如npm-check-updates
)来完成。
"dependencies": {
"@ckeditor/ckeditor5-adapter-ckfinder": "^43.3.0",
"@ckeditor/ckeditor5-autoformat": "^43.3.0",
"@ckeditor/ckeditor5-basic-styles": "^43.3.0",
"@ckeditor/ckeditor5-block-quote": "^43.3.0",
"@ckeditor/ckeditor5-ckfinder": "^43.3.0",
"@ckeditor/ckeditor5-cloud-services": "^43.3.0",
"@ckeditor/ckeditor5-easy-image": "^43.3.0",
"@ckeditor/ckeditor5-editor-classic": "^43.3.0",
"@ckeditor/ckeditor5-essentials": "^43.3.0",
"@ckeditor/ckeditor5-heading": "^43.3.0",
"@ckeditor/ckeditor5-image": "^43.3.0",
"@ckeditor/ckeditor5-indent": "^43.3.0",
"@ckeditor/ckeditor5-link": "^43.3.0",
"@ckeditor/ckeditor5-list": "^43.3.0",
"@ckeditor/ckeditor5-media-embed": "^43.3.0",
"@ckeditor/ckeditor5-paragraph": "^43.3.0",
"@ckeditor/ckeditor5-paste-from-office": "^43.3.0",
"@ckeditor/ckeditor5-table": "^43.3.0",
"@ckeditor/ckeditor5-typing": "^43.3.0"
}
最后,您重新安装包并重新构建编辑器。请注意,有时可能需要删除 package-lock.json
或 yarn.lock
文件。
rm -rf node_modules && yarn install && yarn run build
就这样!您的编辑器已更新,现在您可以专注于调整您的自定义解决方案(如有需要)。如果您使用实时协作,请查看下一节。
# 实时协作
在使用实时协作时,务必记住要为更新的编辑器准备现有文档。基本上,无法加入使用与客户端不同的 CKEditor 5 版本创建的文档。例如,想象一下,文档是用编辑器版本 30.0.0 初始化的,在更新之后,用户使用编辑器版本 31.0.0 连接到该文档。在这种情况下,将抛出有关不兼容引擎版本的错误。
在最后一个用户断开连接后 24 小时内,协作会话将被删除。您还可以使用云服务 REST API手动清除任何现有的协作会话。在删除协作会话后,用户将能够使用新的编辑器连接到文档。
如果您使用的是本地部署的协作服务器,建议您始终保持其更新,就像 CKEditor 5 一样。我们的协作功能与云服务密切相关,因此保持本地部署和 CKEditor 5 之间的兼容性非常重要。
我们每天都在努力使我们的文档保持完整。您是否发现过时的信息?是否缺少内容?请通过我们的问题跟踪器报告。
随着 42.0.0 版本的发布,我们重新编写了大部分文档以反映新的导入路径和功能。感谢您的反馈,帮助我们确保其准确性和完整性。