@seanecoffey/ckeditor5

Custom CKEditor5 component build for Wiki.js

Usage no npm install needed!

<script type="module">
  import seanecoffeyCkeditor5 from 'https://cdn.skypack.dev/@seanecoffey/ckeditor5';
</script>

README

CKEditor 5 document editor build

Join the chat at https://gitter.im/ckeditor/ckeditor5 npm version Build Status
Dependency Status devDependency Status

The document editor build for CKEditor 5, featuring the decoupled UI editor implementation. Read more about the document editor build and see the demo.

CKEditor 5 decoupled document editor build screenshot

Documentation

See:

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-decoupled-document

And use it in your website:

<div id="editor">
    <p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-decoupled-document/build/ckeditor.js"></script>
<script>
    DecoupledEditor
        .create( '<h2>Hello world!</h2>', {
            toolbarContainer: document.querySelector( '.toolbar-container' ),
            editableContainer: document.querySelector( '.editable-container' )
        } )
        .then( editor => {
            window.editor = editor;
        } )
        .catch( err => {
            console.error( err.stack );
        } );
</script>

Or in your JavaScript application:

import DecoupledEditor from '@ckeditor/ckeditor5-build-decoupled-document';

// Or using the CommonJS version:
// const DecoupledEditor = require( '@ckeditor/ckeditor5-build-decoupled-document' );

DecoupledEditor
    .create( '<h2>Hello world!</h2>', {
        toolbarContainer: document.querySelector( '.toolbar-container' ),
        editableContainer: document.querySelector( '.editable-container' )
    } )
    .then( editor => {
        window.editor = editor;
    } )
    .catch( err => {
        console.error( err.stack );
    } );

Note: If you are planning to integrate CKEditor 5 deep into your application, it is actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js). Read more in the Advanced setup guide.

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.