Assemble middleware for downloading files from GitHub.
HTML JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
test
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
.verb.md
Gruntfile.js
LICENSE
README.md
bower.json
index.js
package.json

README.md

grunt-assemble-download NPM version

Assemble plugin for downloading files from GitHub.

Quickstart

In the command line, run:

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:

assemble: {
  options: {
    plugins: ['grunt-assemble-download', 'other/plugins/*.js']
  }
}

Visit the plugins docs 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

assemble: {
  options: {
    plugins: ['grunt-assemble-download'],
    download: {
      repo: 'assemble/handlebars-helpers',
      files: ['docs/helpers.zip'],
      dest: 'tmp/'
    }
  }
}

Assemble plugins

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Authors

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on September 25, 2015.