UNPKG

docpad-plugin-raw

Version:

DocPad plugin that copies /raw directory to /out

165 lines (102 loc) 10.2 kB
<!-- TITLE/ --> <h1>Raw Files Plugin for DocPad</h1> <!-- /TITLE --> <!-- BADGES/ --> <span class="badge-travisci"><a href="http://travis-ci.com/docpad/docpad-plugin-raw" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/com/docpad/docpad-plugin-raw/master.svg" alt="Travis CI Build Status" /></a></span> <span class="badge-npmversion"><a href="https://npmjs.org/package/docpad-plugin-raw" title="View this project on NPM"><img src="https://img.shields.io/npm/v/docpad-plugin-raw.svg" alt="NPM version" /></a></span> <span class="badge-npmdownloads"><a href="https://npmjs.org/package/docpad-plugin-raw" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/docpad-plugin-raw.svg" alt="NPM downloads" /></a></span> <span class="badge-daviddm"><a href="https://david-dm.org/docpad/docpad-plugin-raw" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/docpad/docpad-plugin-raw.svg" alt="Dependency Status" /></a></span> <span class="badge-daviddmdev"><a href="https://david-dm.org/docpad/docpad-plugin-raw#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/docpad/docpad-plugin-raw.svg" alt="Dev Dependency Status" /></a></span> <br class="badge-separator" /> <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span> <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span> <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span> <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span> <span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span> <!-- /BADGES --> Copies all files in the raw directory to out. Useful for large files that cause out of memory error when placed in files directory. ## Configuration Set as many sources as you want. Path should be relative to the `src` directory. The out folder specified in your [docpad configuration file](http://docpad.org/docs/config) is used for the destination. If no configuration is specified, defaults to `raw` folder ``` # ... plugins: raw: raw: src: 'raw' app: src: 'app' # ... ``` You can also specify copy options as specified by [ncp package](https://github.com/AvianFlu/ncp): ``` # ... plugins: raw: raw: src: 'raw' options: dereference: true # default in our plugin is `true` clobber: false # default in our plugin is `false` # ... ``` You can also use a shell command instead of the ncp package if you want: ``` # ... plugins: raw: raw: command: ['rsync', '-a', './src/raw/', './out/'] # ... ``` <!-- INSTALL/ --> <h2>Install</h2> Install this DocPad plugin by entering <code>docpad install raw</code> into your terminal. <!-- /INSTALL --> <!-- HISTORY/ --> <h2>History</h2> <a href="https://github.com/docpad/docpad-plugin-raw/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a> <!-- /HISTORY --> <!-- CONTRIBUTE/ --> <h2>Contribute</h2> <a href="https://github.com/docpad/docpad-plugin-raw/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a> <!-- /CONTRIBUTE --> <!-- BACKERS/ --> <h2>Backers</h2> <h3>Maintainers</h3> These amazing people are maintaining this project: <ul><li><a href="https://github.com/balupton">Benjamin Lupton</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository docpad/docpad-plugin-raw">view contributions</a></li> <li><a href="https://github.com/hypercubed">J. Harshbarger</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=hypercubed" title="View the GitHub contributions of J. Harshbarger on repository docpad/docpad-plugin-raw">view contributions</a></li></ul> <h3>Sponsors</h3> No sponsors yet! Will you be the first? <span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span> <span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span> <span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span> <span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span> <span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span> <span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span> <span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span> <span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span> <span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span> <h3>Contributors</h3> These amazing people have contributed code to this project: <ul><li><a href="https://github.com/balupton">Benjamin Lupton</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository docpad/docpad-plugin-raw">view contributions</a></li> <li><a href="https://github.com/Hypercubed">Jayson Harshbarger</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=Hypercubed" title="View the GitHub contributions of Jayson Harshbarger on repository docpad/docpad-plugin-raw">view contributions</a></li> <li><a href="https://github.com/stongo">Marcus Stong</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=stongo" title="View the GitHub contributions of Marcus Stong on repository docpad/docpad-plugin-raw">view contributions</a></li> <li><a href="http://circleci.com">Marcus Stong</a></li> <li><a href="https://github.com/nsonnad">Nikhil S</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=nsonnad" title="View the GitHub contributions of Nikhil S on repository docpad/docpad-plugin-raw">view contributions</a></li> <li><a href="https://github.com/RobLoach">Rob Loach</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=RobLoach" title="View the GitHub contributions of Rob Loach on repository docpad/docpad-plugin-raw">view contributions</a></li> <li><a href="https://github.com/vsopvsop">vsopvsop</a><a href="https://github.com/docpad/docpad-plugin-raw/commits?author=vsopvsop" title="View the GitHub contributions of vsopvsop on repository docpad/docpad-plugin-raw">view contributions</a></li></ul> <a href="https://github.com/docpad/docpad-plugin-raw/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a> <!-- /BACKERS --> <!-- LICENSE/ --> <h2>License</h2> Unless stated otherwise all works are: <ul><li>Copyright &copy; 2013+ <a href="https://github.com/hypercubed">J. Harshbarger</a></li></ul> and licensed under: <ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul> <!-- /LICENSE -->