Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/signalkuppe/grunt-gathercontent
get content from gathercontent.com
https://github.com/signalkuppe/grunt-gathercontent
Last synced: about 1 month ago
JSON representation
get content from gathercontent.com
- Host: GitHub
- URL: https://github.com/signalkuppe/grunt-gathercontent
- Owner: signalkuppe
- License: mit
- Created: 2014-12-11T10:22:14.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-02T10:40:02.000Z (almost 8 years ago)
- Last Synced: 2024-10-14T07:11:35.391Z (3 months ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# grunt-gathercontent
> get content and files from [Gathercontent](https://gathercontent.com/)
## 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](https://github.com/aaaristo/grunt-html-builder)
## Getting Started
This plugin requires Grunt.
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-gathercontent --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-gathercontent');
```
and fired with
```js
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
```js
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](http://www.signalkuppe.com). Licensed under the MIT license.