https://github.com/mistralys/appframework-ckeditor5
CKEditor5 build for the Application Framework's default markup editor.
https://github.com/mistralys/appframework-ckeditor5
Last synced: 12 months ago
JSON representation
CKEditor5 build for the Application Framework's default markup editor.
- Host: GitHub
- URL: https://github.com/mistralys/appframework-ckeditor5
- Owner: Mistralys
- License: other
- Created: 2023-07-27T13:01:25.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-27T13:29:59.000Z (about 3 years ago)
- Last Synced: 2025-01-22T18:14:37.055Z (over 1 year ago)
- Language: JavaScript
- Size: 1.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Application Framework CKEditor5 build
CKEditor5 build for the [Application Framework][]'s default markup editor.
> This is based on a CKEditor5 editor build generated by the
[Online builder tool][], with some adjustments to make it work with
the framework's MarkupEditor classes.
## Working principle
The file `src/ckeditor.js` is the configuration for the editor build.
This contains the list of plugins that will be available in the editor,
and that can be enabled at will with the markup editor's methods.
The configuration file is used to compile everything into a single
JavaScript file, from the source code to CSS and image files. This can
then be included to create Editor instances for Text Area form elements.
## Quick start
Open the `sample/index.html` page in the browser to check out the default
editor settings.
## Development and build
### 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:
```bash
rm -rf node_modules
npm install
```
### Build files
To generate the production file `build/ckeditor.js`:
```bash
npm run build
```
[Application Framework]: https://github.com/Mistralys/application-framework
[Online builder tool]: https://ckeditor.com/ckeditor-5/online-builder