grunt-gathercontent

get content and files from Gathercontent

Why

Gathercontent is a great service to write and store content. With this tool you can use it as a backend for a static site generator like grunt-html-builder

Getting Started

This plugin requires Grunt.

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-gathercontent --save-dev

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

grunt.loadNpmTasks('grunt-gathercontent');

and fired with

grunt gathercontent

The "gathercontent" task

Options

accountName

Type: String

Your gathercontent.com account name

apiKey

Type: String

Your gathercontent.com api key

projectId

Type: String

The project to fetch data from

jsonDest

Type: String Default value: data/json

The directory where the data (json) will be saved

fileDest

Type: String Default value: data/files

The directory where the files will be saved

downloadFiles

Type: Boolean Default value: true

Setting this to false will prevent the task from downloading the project's files

pageDir

Type: Boolean Default value: true

Puts every file from a page in a directory named with the page_id (1288859/filename.jpg...))

Usage Examples

grunt.initConfig({
  gathercontent: {
    accountName: 'your_account_name',
    apiKey:'your_api_key',
    projectId: 'your_project_number',
    jsonDest: 'data/json',
    fileDest: 'data/files',
    downloadFiles: true,
    pageDir: true
  }
})

To Do

• Transform data for easier manipulation
• performance

License

Copyright (c) 2014 signalkuppe. Licensed under the MIT license.