Contribute to this guideReport an issue

guidePlugin SDK Introduction

The aim of this SDK is to show you how to create custom CKEditor 4 plugins.

# What is a Plugin?

Plugins are the most important building blocks of CKEditor. They provide all editor features, including user interface rendering, text manipulation, data input and output, etc. They are built on top of the base which is called the CKEditor Core, represented by the CKEditor Core API.

A huge variety of plugins is provided by both the core CKEditor development team and the CKEditor developers community. The CKEditor Add-on Repository is the starting point to find and share them. See the Installing Plugins article for more information about how to add additional plugins to create a custom CKEditor 4 build.

# Developing Custom Plugins

Learning by example is always the best idea, so check our plugin tutorials that will show you how to create some basic plugins.

  1. Creating a CKEditor 4 Plugin in 20 Lines of Code – Create your first CKEditor 4 plugin that inserts a piece of HTML code into the document.
  2. Simple Plugin, Part 1 – Develop a basic Abbreviation plugin with a dialog window that lets the user insert a an abbreviation element into the document.
  3. Simple Plugin, Part 2 – Modify the Abbreviation plugin by adding a custom context menu and abbreviation editing capabilities.
  4. Integrating Plugins with Advanced Content Filter – Learn how to implement Advanced Content Filter support in your plugins.
  5. Plugin Stylesheets – Tips on how to integrate custom plugin stylesheets with CKEditor 4.
  6. Plugin Definition API – Detailed description of the plugin definition.
  7. Live Demos – See the working demos of the custom Timestamp and Abbreviation plugins created in the tutorials live in action in CKEditor 4 Examples.