CKEditor 5 Vite 插件

整合 电脑编辑 5'在您的创建过程中' 维特 设置.

实验特性

使用此插件从维特的源头来构建CKEditor 5仍然处于实验阶段. 我们鼓励你测试一下,给我们反馈。 然而,在更为复杂的应用/使用情况中可能存在一些问题,因此尚未建议在生产应用中使用这种解决办法.

使用量

您应该使用此插件时 从源代码创建 CKEditor 5 在Vite应用程序中。 它处理装入 .svg 图标和样式。 如果您的编辑器已经建好了( 例如您从 CKEditor 5 在线构建器)那么此插件就不需要了.

1. 安装软件包 .

npm install -D @ckeditor/vite-plugin-ckeditor5
# or
yarn add -D @ckeditor/vite-plugin-ckeditor5

2. 导入并使用 Vite 配置中的插件 .

// vite.config.js
import { defineConfig } from 'vite';
import ckeditor5 from '@ckeditor/vite-plugin-ckeditor5';

export default defineConfig( {
    plugins: [
        ckeditor5( { theme: require.resolve( '@ckeditor/ckeditor5-theme-lark' ) } )
    ]
} );

选项 :

theme

这应该是主题包中的主文件的绝对路径. 示例

{ theme: require.resolve( '@ckeditor/ckeditor5-theme-lark' ) }

注意: 如果您在无害环境管理项目中使用了此插件, 您可能会遇到一个错误 require.resolve 不是一个函数。 在此情况下,您可以在您的顶部添加以下内容: vite.config.js 文件 :

import { createRequire } from 'node:module';
const require = createRequire( import.meta.url );

已知问题

• 此插件不会发出任何翻译文件, 目前只支持英语 .
• 当使用"导出为Word"或"导出为PDF"插件时,编辑器样式不会自动被收集.

释放软件包

更改日志

在启动发布进程之前, 您需要生成更改日志 :

npm run changelog

出版

生成更改日志后, 您可以发布软件包 .

首先,你需要撞出版本:

npm run release:bump-version

你也可以使用这个 --dry-run 选项,以查看任务的效果.

撞出版本后,您可以发布更改 :

npm run release:publish

与先前的任务一样 --dry-run 选项.

注:只有 dist/ 目录将公布.

许可证

根据下列规定获得许可证: GNU 通用公共许可证版本 2 或稍后版本请检查date=中的日期值 (帮助) LICENSE.md 文档.