node package manager
Loosely couple your services. Use Orgs to version and reuse your code. Create a free org »

assemble-middleware-download

assemble-middleware-download NPM version

Assemble plugin for downloading files from GitHub.

Upgrade notice! v0.2.0 or greater of this plugin depend on Assemble v0.5.0. This plugin will not work with Assemble v0.4.0!`

Quickstart

In the command line, run:

npm install assemble-middleware-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: ['assemble-middleware-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: ['assemble-middleware-download'],
    download: {
      repo: 'assemble/handlebars-helpers',
      files: ['docs/helpers.zip'],
      dest: 'tmp/'
    }
  }
}

Contributing

Find a bug? Have a feature request? Please create an Issue.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and run docs in the command line to build the docs with Verb.

Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!

Assemble plugins

Here are some related projects you might be interested in from the Assemble core team.

  • assemble-contrib-anchors: Assemble plugin for creating anchor tags from generated html.
  • assemble-contrib-contextual: Generates a JSON file containing the context of each page. Basic plugin to help see what's happening in the build.
  • assemble-contrib-decompress: Assemble plugin for extracting zip, tar and tar.gz archives.
  • assemble-contrib-lunr: Assemble plugin for creating a search engine within your static site using lunr.js.
  • assemble-contrib-markdown: Convert markdown files to HTML using marked.js. This plugin is an alternative to Assemble's markdown Handlebars helpers. Both are useful in different scenarios.
  • assemble-contrib-permalinks: Permalinks plugin for Assemble, the static site generator for Grunt.js and Yeoman. This plugin enables powerful and configurable URI replacement patterns, presets, uses Moment.js for parsing dates, and much more.
  • assemble-contrib-sitemap: Sitemap generator plugin for Assemble
  • assemble-contrib-toc: Create a table of contents in the generated HTML, using Cheerio.js
  • assemble-contrib-wordcount: Assemble plugin for displaying a word-count on blog posts or pages.

Visit assemble.io/plugins for more information about Assemble plugins.

Authors

Jon Schlinkert

Brian Woodward

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license


This file was generated by grunt-verb on May 02, 2014.