@4ch3los/ckeditor5-build-gomme 中文文档教程
CKEditor 5 editor generated with the online builder
这个存储库提供了一个由 Online builder tool 生成的 CKEditor 5 编辑器构建
Quick start
- Open the
sample/index.htmlpage in the browser.
如果您选择了实时协作插件：
使用正确的令牌、websocket 和上传 URL 端点填充对话框。 如果您还没有这些或不知道它们的含义，请联系我们。
复制 URL 并共享或粘贴到另一个选项卡以享受实时协作编辑。
如果您选择了非实时协作插件：
- Fill the prompt with the license key. If you do not have the license key yet contact us.
Configuring build
更改工具栏项目、更改图标顺序或自定义插件配置等更改应该相对容易进行。 打开 sample/index.html 文件并编辑初始化 CKEditor 的脚本 5. 保存文件并刷新浏览器。 就这样。
注意：如果您对浏览器缓存有任何问题，请根据您的系统使用 Ctrl + R 或 Cmd + R 快捷方式。
但是，如果您想在构建中删除或添加插件，则需要按照本指南的下一步操作。
请注意，也可以返回到Online builder tool 并选择其他插件集。 但我们鼓励您尝试更难的方法并学习 Node.js 和 CKEditor 5 生态系统的原理，这将使您在未来做更多很酷的事情！
Installation
为了重建应用程序，您需要先安装所有依赖项。 为此，请在项目目录中打开终端并键入：
npm install
确保首先安装了 node 和 npm。 如果没有，请按照 Node.js 文档页面 上的说明进行操作。
Adding or removing plugins
现在您可以在构建中安装其他插件。 只需按照添加插件到编辑器教程
Rebuilding editor
如果您已经完成安装 和添加或删除插件 a> 步骤，您已准备好通过运行以下命令重建编辑器：
npm run build
这会将 CKEditor 5 构建到 build 目录。 您可以打开浏览器，您应该能够看到您在代码中所做的更改。 如果没有，则尝试通过键入 Ctrl + R 或 Cmd + R 刷新浏览器缓存，具体取决于您的系统。
What's next?
按照 https://ckeditor.com/docs/ckeditor5/latest/framework/index.html 上提供的指南进行操作，享受文档编辑。
FAQ
| 报告错误和功能请求的地方在哪里？
您可以在 https://github.com/ckeditor/ckeditor5/issues 上创建问题，包括构建 ID - ws0yvd61g2g0-l1kmnqku0ie。 确保问题/问题是唯一的，请在搜索框中查找可能提出的问题。 重复的将被关闭。
| 在哪里可以了解有关 CKEditor 5 框架的更多信息？
这里：https://ckeditor.com/docs/ckeditor5/latest/framework/
| 是否可以将在线构建器与 React、Vue 或 Angular 等常见框架一起使用？
还没有，但这些集成将在未来的某个时候可用。
CKEditor 5 editor generated with the online builder
This repository presents a CKEditor 5 editor build generated by the Online builder tool
Quick start
- Open the
sample/index.htmlpage in the browser.
If you picked the real-time collaboration plugins:
Fill the dialog with correct token, websocket and upload URL endpoints. If you do not have these yet or do not know their meaning, contact us.
Copy the URL and share it or paste in another tab to enjoy real-time collaborative editing.
If you picked the non-real-time collaboration plugins:
- Fill the prompt with the license key. If you do not have the license key yet contact us.
Configuring build
Changes like changing toolbar items, changing order of icons or customizing plugin configurations should be relatively easy to make. Open the sample/index.html file and edit the script that initialized the CKEditor 5. Save the file and refresh the browser. That's all.
Note: If you have any problems with browser caching use the Ctrl + R or Cmd + R shortcut depending on your system.
However if you want to remove or add a plugin to the build you need to follow the next step of this guide.
Note that it is also possible to go back to the Online builder tool and pick other set of plugins. But we encourage you to try the harder way and to learn the principles of Node.js and CKEditor 5 ecosystems that will allow you to do more cool things in the future!
Installation
In order to rebuild the application you need to install all dependencies first. To do it, open the terminal in the project directory and type:
npm install
Make sure that you have the node and npm installed first. If not, then follow the instructions on the Node.js documentation page.
Adding or removing plugins
Now you can install additional plugin in the build. Just follow the Adding a plugin to an editor tutorial
Rebuilding editor
If you have already done the Installation and Adding or removing plugins steps, you're ready to rebuild the editor by running the following command:
npm run build
This will build the CKEditor 5 to the build directory. You can open your browser and you should be able to see the changes you've made in the code. If not, then try to refresh also the browser cache by typing Ctrl + R or Cmd + R depending on your system.
What's next?
Follow the guides available on https://ckeditor.com/docs/ckeditor5/latest/framework/index.html and enjoy the document editing.
FAQ
| Where is the place to report bugs and feature requests?
You can create an issue on https://github.com/ckeditor/ckeditor5/issues including the build id - ws0yvd61g2g0-l1kmnqku0ie. Make sure that the question / problem is unique, please look for a possibly asked questions in the search box. Duplicates will be closed.
| Where can I learn more about the CKEditor 5 framework?
Here: https://ckeditor.com/docs/ckeditor5/latest/framework/
| Is it possible to use online builder with common frameworks like React, Vue or Angular?
Not yet, but it these integrations will be available at some point in the future.
