https://github.com/assemble/grunt-assemble-download
Assemble middleware for downloading files from GitHub.
https://github.com/assemble/grunt-assemble-download
Last synced: 10 months ago
JSON representation
Assemble middleware for downloading files from GitHub.
- Host: GitHub
- URL: https://github.com/assemble/grunt-assemble-download
- Owner: assemble
- License: mit
- Created: 2013-11-28T18:54:29.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-09-25T13:15:07.000Z (over 10 years ago)
- Last Synced: 2025-08-09T01:42:36.065Z (10 months ago)
- Language: HTML
- Homepage:
- Size: 340 KB
- Stars: 4
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-assemble-download [](http://badge.fury.io/js/grunt-assemble-download)
> Assemble plugin for downloading files from GitHub.
## Quickstart
In the command line, run:
```bash
npm install grunt-assemble-download --save
```
Next, to register the plugin with Assemble in your project's Gruntfile you can either specify the direct path to the plugin(s) (e.g. `./path/to/plugins/*.js`), or if installed via npm, make sure the plugin is in the `devDependencies` of your project.js package.json, and simply add the module's name to the `plugins` option:
```js
assemble: {
options: {
plugins: ['grunt-assemble-download', 'other/plugins/*.js']
}
}
```
Visit the [plugins docs](http://assemble.io/plugins/) for more info or for help getting started.
## Options
## repo
Type: `String`
Default: `assemble/handlebars-helpers`
Repo from which to download files.
## dest
Type: `String`
Default: `tmp/`
Destination for the downloaded files.
## files
Type: `Array`
Default: `['docs/helpers.zip']`
Paths the file or files to download.
## Usage Examples
```js
assemble: {
options: {
plugins: ['grunt-assemble-download'],
download: {
repo: 'assemble/handlebars-helpers',
files: ['docs/helpers.zip'],
dest: 'tmp/'
}
}
}
```
## Assemble plugins
* [grunt-assemble](https://www.npmjs.com/package/grunt-assemble): Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… [more](https://www.npmjs.com/package/grunt-assemble) | [homepage](http://assemble.io)
* [grunt-assemble-anchors](https://www.npmjs.com/package/grunt-assemble-anchors): Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js. | [homepage](https://github.com/assemble/grunt-assemble-anchors)
* [grunt-assemble-contextual](https://www.npmjs.com/package/grunt-assemble-contextual): Generates a JSON file with the context of each page. Basic plugin to help see… [more](https://www.npmjs.com/package/grunt-assemble-contextual) | [homepage](https://github.com/assemble/grunt-assemble-contextual)
* [grunt-assemble-decompress](https://www.npmjs.com/package/grunt-assemble-decompress): Assemble plugin for extracting zip, tar and tar.gz archives. | [homepage](https://github.com/assemble/grunt-assemble-decompress)
* [grunt-assemble-i18n](https://www.npmjs.com/package/grunt-assemble-i18n): Plugin for adding i18n support to Assemble projects. | [homepage](https://github.com/assemble/grunt-assemble-i18n)
* [grunt-assemble-lunr](https://www.npmjs.com/package/grunt-assemble-lunr): Assemble plugin for adding search capabilities to your static site, with lunr.js. | [homepage](http://assemble.io)
* [grunt-assemble-navigation](https://www.npmjs.com/package/grunt-assemble-navigation): Assemble navigation plugin. Automatically generate Bootstrap-style, multi-level side nav. See the sidenav on assemble.io for… [more](https://www.npmjs.com/package/grunt-assemble-navigation) | [homepage](https://github.com/assemble/grunt-assemble-navigation)
* [grunt-assemble-permalinks](https://www.npmjs.com/package/grunt-assemble-permalinks): Permalinks plugin for Assemble, the static site generator for Grunt.js, Yeoman and Node.js. This plugin… [more](https://www.npmjs.com/package/grunt-assemble-permalinks) | [homepage](https://github.com/assemble/grunt-assemble-permalinks)
* [grunt-assemble-sitemap](https://www.npmjs.com/package/grunt-assemble-sitemap): Sitemap plugin for Assemble | [homepage](http://assemble.io/plugins)
* [grunt-assemble-toc](https://www.npmjs.com/package/grunt-assemble-toc): Assemble middleware for adding a Table of Contents (TOC) to any HTML page. | [homepage](http://assemble.io)
* [grunt-assemble-wordcount](https://www.npmjs.com/package/grunt-assemble-wordcount): Assemble plugin for displaying wordcount and average reading time to blog posts or pages. | [homepage](https://github.com/assemble/grunt-assemble-wordcount)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/assemble/grunt-assemble-download/issues/new).
## Authors
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 25, 2015._