Skip to content

davemil/grapesjs-plugin-ckeditor5

 
 

Repository files navigation

GrapesJS CKEditor5

This plugin replaces the default Rich Text Editor with CKEditor5 inline build

Under development DO NOT USE

Summary

  • Plugin
    • Name: gjs-plugin-ckeditor5
    • Options:
      • options CKEditor5's configuration object, eg. { language: 'en', toolbar: [...], ...}
      • position Position side of the toolbar, default: left, options: left|center|right

Ckeditor5 information can be found at https://ckeditor.com/docs/ckeditor5/latest/
This plugin uses v15.0.0

Download

Usage

<script src="https://cdn.ckeditor.com/ckeditor5/15.0.0/inline/ckeditor.js"></script>
<link href="path/to/grapes.min.css" rel="stylesheet"/>
<script src="path/to/grapes.min.js"></script>
<script src="path/to/grapesjs-plugin-ckeditor.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
      container : '#gjs',
      plugins: ['gjs-plugin-ckeditor'],
      pluginsOpts: {
        'gjs-plugin-ckeditor': {/* ...options */}
      }
  });
</script>

Development

Clone the repository

$ git clone https://github.com/artf/grapesjs-plugin-ckeditor.git
$ cd grapesjs-plugin-ckeditor

Install dependencies

$ npm i

The plugin relies on GrapesJS and CKEditor via peerDependencies so you have to install them manually

$ npm i grapesjs ckeditor --no-save

Start the dev server

$ npm start

License

BSD 3-Clause

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 59.6%
  • JavaScript 40.4%