Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@jdinabox/ckeditor5-build-markdown

17.0.0 • Public • Published

CKEditor 5 markdown editor build

npm version npm downloads
Dependency Status devDependency Status

Based on 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 (for classic editor build)

See:

Quick start

First, install the build from npm:

npm install --save @jdinabox/ckeditor5-build-markdown

And use it in your website:

<div id="editor">
    <p>This is the editor content.</p>
</div>
<script src="./node_modules/@jdinabox/ckeditor5-build-markdown/build/ckeditor.js"></script>
<script>
    MarkdownEditor
        .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 MarkdownEditor from '@jdinabox/ckeditor5-build-markdown';
 
// Or using the CommonJS version:
// const MarkdownEditor = require( '@jdinabox/ckeditor5-build-markdown' );
 
MarkdownEditor
    .create( document.querySelector( '#editor' ) )
    .then( editor => {
        window.editor = editor;
    } )
    .catch( error => {
        console.error( 'There was a problem initializing the editor.', error );
    } );

Setting Data

editor.setData('## Markdown Heading');

Getting Data

editor.getData();

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.

Install

npm i @jdinabox/ckeditor5-build-markdown

DownloadsWeekly Downloads

202

Version

17.0.0

License

GPL-2.0-or-later

Unpacked Size

4.98 MB

Total Files

66

Last publish

Collaborators

  • avatar