Getting started - lokothodida/ckeditor-plugin-template GitHub Wiki

Requirements

Steps

Download /your-plugin to your desired folder (e.g. the /plugins directory of your CKEditor installation)
Pick a suitable id for your plugin (ideally hyphenated instead of spaced or camelCased).
Open the your-plugin/plugin.js file and modify the plugin variable:

var plugin = {}; plugin.id = 'your-plugin'; // modify to id in (2) plugin.title = 'Your Plugin'; // your title plugin.label = 'Your Plugin Label'; // your label plugin.command = 'yourPlugin'; // ideally id in (2) but camelCased // and more ... ``` 4. Open the your-plugin/dialogs/main.js file and rename `your-plugin` to the id in (2) on the following lines at the top of the page:

```javascript
...
// get plugin path
var path = CKEDITOR.plugins.get('your-plugin').path;

// get plugin details
var plugin = CKEDITOR.plugins.registered['your-plugin'].details;
...
```

Finally, rename the following files/folders, replacing your-plugin again with your id in (2):
```
/your-plugin
/your-plugin/icons/your-plugin.png
```

You are ready to start developing your CKEditor plugin as per their documentation.