@jdinabox/ckeditor5-build-markdown

CKEditor 5 markdown editor build

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

Documentation (for classic editor build)

See:

• Installation for how to install this package and what it contains.
• Basic API for how to create an editor and interact with it.
• Configuration for how to configure the editor.
• Creating custom builds for how to customize the build (configure and rebuild the editor bundle).

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( err => {
			console.error( err.stack );
		} );
</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( err => {
		console.error( err.stack );
	} );

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.