grunt-template-publisher v0.2.3

grunt-template-publisher

uploads a Jimdo template to the Jimdo designs api.

Getting Started

This plugin requires Grunt ~0.4.5

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-template-publisher --save-dev

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

grunt.loadNpmTasks('grunt-template-publisher');

The "template_publisher" task

Authentication

In order to Authenticate with the designs API you need a OAuth access token. The plugin will take care of getting one, but you have to provide a username and a password.

You can provide your username via the environment DMP_USER or specifiy it in the config (see the next section). When not given the plugin will promt you to enter it.

You can provide the password via the environment DMP_PASSWORD. When not given the plugin will promt you to enter it.

Overview

In your project's Gruntfile, add a section named template_publisher to the data object passed into grunt.initConfig(). Don't forget to change the design_id to the considering one of your template.

grunt.initConfig({
  publish: {
    options: {
      username: 'dmp@jimdo.com',
      design_id: 316,
      image_folder: 'gfx'
    }
  }
});

Activate a design version

When calling the grunt task, you can append --activate to the call and it will automatically activate the design version.

Options

options.username

optional Type: String

Your Jimdo design API username. You will be prompted to enter your username along with the password when not given.

options.design_id

Type: Integer

The Jimdo Designs API design id. Assigend when you created the template.

options.image_folder

optional Type: String

The local image folder, all files found in there, will be uploaded to the API.

options.endpoint

Type: String Default value: https://api.dmp.jimdo-server.com

The Designs API endpoint to use, defaults to the live system. But you can also use your development app.

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

(Nothing yet)