You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 lines
1.7 KiB

  1. # [GitHub Pages](http://pages.github.com/) Deployer Plugin for [DocPad](http://docpad.org)
  2. [![NPM version](https://badge.fury.io/js/docpad-plugin-ghpages.png)](https://npmjs.org/package/docpad-plugin-ghpages "View this project on NPM")
  3. [![Flattr donate button](https://raw.github.com/balupton/flattr-buttons/master/badge-89x18.gif)](http://flattr.com/thing/344188/balupton-on-Flattr "Donate monthly to this project using Flattr")
  4. [![PayPayl donate button](https://www.paypalobjects.com/en_AU/i/btn/btn_donate_SM.gif)](https://www.paypal.com/au/cgi-bin/webscr?cmd=_flow&SESSION=IHj3DG3oy_N9A9ZDIUnPksOi59v0i-EWDTunfmDrmU38Tuohg_xQTx0xcjq&dispatch=5885d80a13c0db1f8e263663d3faee8d14f86393d55a810282b64afed84968ec "Donate once-off to this project using Paypal")
  5. Deploy to Github Pages easily via `docpad deploy-ghpages`
  6. ## Install
  7. ```
  8. npm install --save docpad-plugin-ghpages
  9. ```
  10. ## Usage
  11. Run `docpad deploy-ghpages` to deploy the contents of your out directory directly to your repo's `gh-pages` branch. No configuration or setup required.
  12. ## History
  13. [You can discover the history inside the `History.md` file](https://github.com/bevry/docpad-plugin-ghpages/blob/master/History.md#files)
  14. ## Contributing
  15. [You can discover the contributing instructions inside the `Contributing.md` file](https://github.com/bevry/docpad-plugin-ghpages/blob/master/Contributing.md#files)
  16. ## License
  17. Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)
  18. <br/>Copyright &copy; 2013+ [Bevry Pty Ltd](http://bevry.me) <us@bevry.me>
  19. ## Contributors
  20. - [Benjamin Lupton](http://github.com/balupton)
  21. - [Avi Deitcher](http://github.com/deitch)
  22. - [Sergey Lukin](http://github.com/sergeylukin)