Home - lokothodida/ckeditor-plugin-template GitHub Wiki

Welcome to the CKEditor Plugin Template wiki!

Current Version: 0.1
CKEditor Version: 4.3.2+

Scenario

Say that you want to provide a CKEditor plugin that embeds a particular HTML markup. The more complicated it is, the less scalable your plugin will be when you decide to add/remove features in the future.

That isn't even considering what would happen if the underlying code has to change in the future. For example, imagine that you wanted a video-embed plugin for a certain service, and your plugin embeds the raw HTML that the service provides. If that service changes the way that they handle video-embed code, you now have to completely change the html output for your plugin.

Purpose of the template

Having a generic placeholder inserted instead of the raw HTML markup allows you to then manipulate the output page with HTML to produce the correct output (presumable with JavaScript). This template provides a suitable boilerplate for quickly producing these types of plugins.

Contributing

[Opening issues](Opening issues)
[Contributing to the codebase](Contributing to the codebase)

Usage documentation