Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Download (and optionally extract) files into your project before your project starts generating
CoffeeScript
branch: master
Failed to load latest commit information.
src
test
.editorconfig
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
Cakefile
HISTORY.md
LICENSE.md
README.md
coffeelint.json
package.json

README.md

Downloader Plugin for DocPad

Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Download (and optionally extract) files into your project before your project starts generating

Install

docpad install downloader

Usage

Define the following inside your docpad configuration file, changing the repo values to what you desire:

module.exports =
    plugins:
        downloader:
            downloads: [
                {
                    name: 'Gist Bundle'
                    path: 'src/documents/gist'
                    url: 'https://gist.github.com/balupton/5432249/download'
                    tarExtractClean: true
                }
                {
                    name: 'Gist File'
                    path: 'src/documents/a.html.md'
                    url: 'https://gist.github.com/balupton/5432249/raw/1e1cd6d374d0565aaab30566ec9055219d857aec/a.html.md'
                }
            ]

Available download options:

  • name string, name of the download, for logging purposes only
  • path string, path that the completed download is placed
  • url string, url the download is retrieved from
  • deflate boolean, whether or not we should deflate the response when fetching the download (auto-detected if not set)
  • gzip boolean, whether or not we should unzip the response when fetching the download (auto-detected if not set)
  • tarExtract boolean, whether or not we should extract tar downloads (auto-detected if not set)
  • tarExtractClean boolean, whether or not when performing a tar extraction if we should remove the root directory of the extracted files

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Gratipay donate button Flattr donate button PayPayl donate button BitCoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Become a contributor!

License

Unless stated otherwise all works are:

and licensed under:

Something went wrong with that request. Please try again.