ckmd

The classic editor build of CKEditor 5 with github flavored markdown support.

Usage no npm install needed!

<script type="module">
  import ckmd from 'https://cdn.skypack.dev/ckmd';
</script>

README

CKEditor 5 classic editor build, with github flavored markdown support.

npm version Coverage Status Build Status

The classic editor build for CKEditor 5. Read more about the classic editor build and see the demo.

CKEditor 5 classic editor build screenshot

Documentation

See:

Quick start

First, install the build from npm:

npm install --save ckmd

And use it in your website:

<div id="editor">
    <p>This is the editor content.</p>
</div>
<script src="./node_modules/ckmd/build/ckeditor.js"></script>
<script>
    CKMD
        .create( document.querySelector( '#editor' ) )
        .then( editor => {
            window.editor = editor;
        } )
        .catch( error => {
            console.error( 'There was a problem initializing the editor.', error );
        } );
</script>

Or in your JavaScript application:

import CKMD from 'ckmd';

// Or using the CommonJS version:
// const CKMD = require( 'ckmd' );

CKMD
    .create( document.querySelector( '#editor' ) )
    .then( editor => {
        window.editor = editor;
    } )
    .catch( error => {
        console.error( 'There was a problem initializing the editor.', error );
    } );

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.