grunt-ckeditor-contenttemplates

grunt-ckeditor-contenttemplates

Create config file for CKEditor custom templates plugin.

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-ckeditor-contenttemplates --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-ckeditor-contenttemplates');

The "ckeditor_contenttemplates" task

Overview

This plugin creates the configuration JavaScript file for the CKEditor custom templates plugin. To use the plugin you need to create a template file for each custom template that you wish to include. This plugin will then generate the default.js configuration file from these.

Note: this plugin only creates the JavaScript file, use grunt-contrib-copy to place the icons into the templates/images/ folder of your project.

Example template file

title: Image and Title
image: template1.gif
description: One main image with a title and text that surround the image.
--
<h3>
  // Use src=" " so image is not filtered out by the editor as incorrect (src is required).
  <img src=" " alt="" style="margin-right: 10px" height="100" width="100" align="left" />
  Type the title here
</h3>
<p>
  Type the text here
</p>

Example Grunt Config

grunt.initConfig({
  ckeditor_contenttemplates: {
    files: {
      'dest/': 'src/myTemplates/*',
    },
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

• v0.2.0 Code Refactor
• v0.1.0 First Release

License

Copyright © 2014-15 David J. Bradshaw. Licensed under the MIT license.