https://github.com/davidjbradshaw/grunt-ckeditor-contenttemplates

Create config file for CKEditor Content Templates plugin
https://github.com/davidjbradshaw/grunt-ckeditor-contenttemplates

grunt grunt-plugins

Last synced: 2 months ago
JSON representation

Create config file for CKEditor Content Templates plugin

• Host: GitHub
• URL: https://github.com/davidjbradshaw/grunt-ckeditor-contenttemplates
• Owner: davidjbradshaw
• License: mit
• Created: 2014-04-28T16:45:34.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-05-22T08:43:07.000Z (over 6 years ago)
• Last Synced: 2024-10-10T13:21:27.363Z (3 months ago)
• Topics: grunt, grunt-plugins
• Language: JavaScript
• Homepage:
• Size: 17.6 KB
• Stars: 7
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

        
# grunt-ckeditor-contenttemplates

[![npm version](https://badge.fury.io/js/grunt-ckeditor-contenttemplates.svg)](http://badge.fury.io/js/grunt-ckeditor-contenttemplates)

[![Build Status](https://travis-ci.org/davidjbradshaw/grunt-ckeditor-contenttemplates.svg?branch=master)](https://travis-ci.org/davidjbradshaw/grunt-ckeditor-contenttemplates)

![license](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)

> Create config file for [CKEditor custom templates](http://ckeditor.com/addon/templates) plugin.

## Getting Started

This plugin requires Grunt `~0.4.0`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

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:

```js

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

```

## The "ckeditor_contenttemplates" task

### Overview

This plugin creates the configuration JavaScript file for the [CKEditor custom templates](http://ckeditor.com/addon/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](/gruntjs/grunt-contrib-copy) to place the icons into the `templates/images/` folder of your project.*

### Example template file

```html

title: Image and Title

image: template1.gif

description: One main image with a title and text that surround the image.

--



  // Use src=" " so image is not filtered out by the editor as incorrect (src is required).

  

  Type the title here





  Type the text here



```


### Example Grunt Config

```js

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](http://gruntjs.com/).

## Release History

* v0.2.1 Support Grunt v1.0.0

* v0.2.0 Code Refactor

* v0.1.0 First Release

## License

Copyright © 2014-15 [David J. Bradshaw](https://github.com/davidjbradshaw).

Licensed under the [MIT license](http://opensource.org/licenses/MIT).