summaryrefslogtreecommitdiff
path: root/lib/ckeditor5/README.md
diff options
context:
space:
mode:
authorpolo <ordipolo@gmx.fr>2022-02-20 20:49:13 +0100
committerpolo <ordipolo@gmx.fr>2022-02-20 20:49:13 +0100
commit758b3f359341f963946d6d34e8f39d2a9c1f6040 (patch)
tree3efb7f1da4be4157615419e630eb0d6efbcb6c3d /lib/ckeditor5/README.md
parenta5ddb2af05644972de70dab3225bab0797a93934 (diff)
downloadmelaine-758b3f359341f963946d6d34e8f39d2a9c1f6040.zip
debuggage
Diffstat (limited to 'lib/ckeditor5/README.md')
-rw-r--r--lib/ckeditor5/README.md136
1 files changed, 68 insertions, 68 deletions
diff --git a/lib/ckeditor5/README.md b/lib/ckeditor5/README.md
index c5438a7..0f50d9c 100644
--- a/lib/ckeditor5/README.md
+++ b/lib/ckeditor5/README.md
@@ -1,68 +1,68 @@
1# CKEditor 5 editor generated with the online builder 1# CKEditor 5 editor generated with the online builder
2 2
3This repository presents a CKEditor 5 editor build generated by the [Online builder tool](https://ckeditor.com/ckeditor-5/online-builder) 3This repository presents a CKEditor 5 editor build generated by the [Online builder tool](https://ckeditor.com/ckeditor-5/online-builder)
4 4
5## Quick start 5## Quick start
6 6
71. Open the `sample/index.html` page in the browser. 71. Open the `sample/index.html` page in the browser.
8 8
9If you picked the real-time collaboration plugins: 9If you picked the real-time collaboration plugins:
10 10
112. 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](https://ckeditor.com/contact/). 112. 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](https://ckeditor.com/contact/).
12 12
133. Copy the URL and share it or paste in another tab to enjoy real-time collaborative editing. 133. Copy the URL and share it or paste in another tab to enjoy real-time collaborative editing.
14 14
15If you picked the non-real-time collaboration plugins: 15If you picked the non-real-time collaboration plugins:
16 16
172. Fill the prompt with the license key. If you do not have the license key yet [contact us](https://ckeditor.com/contact/). 172. Fill the prompt with the license key. If you do not have the license key yet [contact us](https://ckeditor.com/contact/).
18 18
19## Configuring build 19## Configuring build
20 20
21Changes 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. 21Changes 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.
22 22
23*Note:* If you have any problems with browser caching use the `Ctrl + R` or `Cmd + R` shortcut depending on your system. 23*Note:* If you have any problems with browser caching use the `Ctrl + R` or `Cmd + R` shortcut depending on your system.
24 24
25However if you want to remove or add a plugin to the build you need to follow the next step of this guide. 25However if you want to remove or add a plugin to the build you need to follow the next step of this guide.
26 26
27Note that it is also possible to go back to the [Online builder tool](https://ckeditor.com/ckeditor-5/online-builder) 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! 27Note that it is also possible to go back to the [Online builder tool](https://ckeditor.com/ckeditor-5/online-builder) 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!
28 28
29### Installation 29### Installation
30 30
31In order to rebuild the application you need to install all dependencies first. To do it, open the terminal in the project directory and type: 31In order to rebuild the application you need to install all dependencies first. To do it, open the terminal in the project directory and type:
32 32
33``` 33```
34npm install 34npm install
35``` 35```
36 36
37Make sure that you have the `node` and `npm` installed first. If not, then follow the instructions on the [Node.js documentation page](https://nodejs.org/en/). 37Make sure that you have the `node` and `npm` installed first. If not, then follow the instructions on the [Node.js documentation page](https://nodejs.org/en/).
38 38
39### Adding or removing plugins 39### Adding or removing plugins
40 40
41Now you can install additional plugin in the build. Just follow the [Adding a plugin to an editor tutorial](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html#adding-a-plugin-to-an-editor) 41Now you can install additional plugin in the build. Just follow the [Adding a plugin to an editor tutorial](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html#adding-a-plugin-to-an-editor)
42 42
43### Rebuilding editor 43### Rebuilding editor
44 44
45If you have already done the [Installation](#installation) and [Adding or removing plugins](#adding-or-removing-plugins) steps, you're ready to rebuild the editor by running the following command: 45If you have already done the [Installation](#installation) and [Adding or removing plugins](#adding-or-removing-plugins) steps, you're ready to rebuild the editor by running the following command:
46 46
47``` 47```
48npm run build 48npm run build
49``` 49```
50 50
51This 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. 51This 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.
52 52
53## What's next? 53## What's next?
54 54
55Follow the guides available on https://ckeditor.com/docs/ckeditor5/latest/framework/index.html and enjoy the document editing. 55Follow the guides available on https://ckeditor.com/docs/ckeditor5/latest/framework/index.html and enjoy the document editing.
56 56
57## FAQ 57## FAQ
58| Where is the place to report bugs and feature requests? 58| Where is the place to report bugs and feature requests?
59 59
60You can create an issue on https://github.com/ckeditor/ckeditor5/issues including the build id - `aovpauzd25hi-dqoovaepm42n`. Make sure that the question / problem is unique, please look for a possibly asked questions in the search box. Duplicates will be closed. 60You can create an issue on https://github.com/ckeditor/ckeditor5/issues including the build id - `snbfnxyy4drd-nofxirpg8ewj`. Make sure that the question / problem is unique, please look for a possibly asked questions in the search box. Duplicates will be closed.
61 61
62| Where can I learn more about the CKEditor 5 framework? 62| Where can I learn more about the CKEditor 5 framework?
63 63
64Here: https://ckeditor.com/docs/ckeditor5/latest/framework/ 64Here: https://ckeditor.com/docs/ckeditor5/latest/framework/
65 65
66| Is it possible to use online builder with common frameworks like React, Vue or Angular? 66| Is it possible to use online builder with common frameworks like React, Vue or Angular?
67 67
68Not yet, but it these integrations will be available at some point in the future. 68Not yet, but it these integrations will be available at some point in the future.