https://github.com/docpad/docpad-plugin-downloader

Download (and optionally extract) files into your project before your project starts generating
https://github.com/docpad/docpad-plugin-downloader

docpad-plugin

Last synced: 12 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/docpad/docpad-plugin-downloader
Owner: docpad
License: other
Created: 2013-04-22T05:54:37.000Z (about 13 years ago)
Default Branch: master
Last Pushed: 2024-02-04T11:08:50.000Z (over 2 years ago)
Last Synced: 2025-06-11T15:09:54.146Z (about 1 year ago)
Topics: docpad-plugin
Language: JavaScript
Size: 301 KB
Stars: 2
Watchers: 13
Forks: 1
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

# Downloader Plugin for [DocPad](http://docpad.org)

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

## Install

```bash
docpad install downloader
```

## Usage

Define the following inside your [docpad configuration file](http://docpad.org/docs/config), changing the `repo` values to what you desire:

```coffee
module.exports =
plugins:
downloader:
downloads: [
{
name: 'Zip Bundle'
path: 'src/documents/zip'
url: 'https://gist.github.com/balupton/5432249/archive/dd29c677a72fd7ca53c5aadf5437a4167b389a21.zip',
decompress: {strip: 1}
},
{
name: 'Tar Bundle'
path: 'src/documents/tar'
url: 'https://gist.github.com/balupton/5432249/archive/dd29c677a72fd7ca53c5aadf5437a4167b389a21.tar.gz',
decompress: {strip: 1}
}
{
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
- `decompress` true or object, if object it is the options sent to [decompress](https://www.npmjs.com/package/decompress)