Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

docpad-plugin-downloader

2.5.0 • Public • Published

Downloader Plugin for DocPad

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal 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: '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

History

Discover the release 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?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

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

License

Unless stated otherwise all works are:

and licensed under:

Install

npm i docpad-plugin-downloader

DownloadsWeekly Downloads

8

Version

2.5.0

License

MIT

Unpacked Size

20.5 kB

Total Files

11

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar