https://github.com/combodo/ckeditor5-itop-build
https://github.com/combodo/ckeditor5-itop-build
third-party-libraries
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/combodo/ckeditor5-itop-build
- Owner: Combodo
- License: other
- Created: 2024-04-24T08:23:28.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T19:55:48.000Z (about 2 years ago)
- Last Synced: 2024-05-22T20:09:06.187Z (about 2 years ago)
- Topics: third-party-libraries
- Language: TypeScript
- Homepage:
- Size: 4.8 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CKEditor 5 editor customized for iTop
## Installation
In order to build the editor 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](https://nodejs.org/en/).
## Adding or removing plugins
If you need to add additional CKEditor plugins, you can install them in the build. Just follow the [Adding a plugin to an editor tutorial](https://ckeditor.com/docs/ckeditor5/latest/installation/plugins/installing-plugins.html#adding-a-plugin-to-an-editor)
If you need to build your own plugins check CKEditor's documentation or `src/plugins/` for examples.
## Rebuilding editor
If 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:
```
npm run build
```
This will build the CKEditor 5 to the `build` directory.
## Import your changes to iTop
In order to update iTop CKEditor's build you need to push your changes to github.
Then run the following command in iTop's root directory:
```
npm install https://github.com/Combodo/ckeditor5-itop-build.git --omit=dev
```