assemble-contrib-decompress

Assemble plugin for extracting zip, tar and tar.gz archives.

npm install assemble-contrib-decompress
2 downloads in the last day
22 downloads in the last week
35 downloads in the last month

assemble-contrib-decompress NPM version

Assemble plugin for extracting zip, tar and tar.gz archives.

Quickstart

In the command line, run:

npm install assemble-contrib-decompress --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-contrib-decompress', 'other/plugins/*.js']
  }
}

Visit the plugins docs for more info or for help getting started.

Options

files

Type: String Default: undefined

Path the file or files to decompress.

dest

Type: String Default: undefined

Destination for the decompressed files.

Usage Examples

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

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. Lint and test your code using grunt, and build the documentation with grunt-readme.

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 NPM version

Assemble plugin for creating anchor tags from generated html.

assemble-contrib-contextual NPM version

Generates a JSON file containing the context of each page. Basic plugin to help see what's happening in the build.

assemble-contrib-download NPM version

Assemble plugin for downloading files from GitHub.

assemble-contrib-i18n NPM version

Plugin for adding i18n support to Assemble projects.

assemble-contrib-lunr NPM version

Assemble plugin for creating a search engine within your static site using lunr.js.

assemble-contrib-markdown NPM version

HEADS UP! This isn't ready for prime time! 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-pagination NPM version

Pagination plugin for Assemble, the static site generator for Grunt.js and Yeoman. This plugin enables adding pagable list pages.

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 NPM version

Sitemap generator plugin for Assemble

assemble-contrib-toc NPM version

Create a table of contents in the generated HTML, using Cheerio.js

assemble-contrib-wordcount NPM version

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-readme on Thursday, February 27, 2014.

npm loves you