ape-deploying/README.md

ape-deploying
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/ape-repo/ape-deploying.git
[bd_travis_url]: http://travis-ci.org/ape-repo/ape-deploying.git
[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-deploying.git.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/ape-repo/ape-deploying.git
[bd_travis_com_shield_url]: https://api.travis-ci.com/ape-repo/ape-deploying.git.svg?token=
[bd_license_url]: https://github.com/ape-repo/ape-deploying.git/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-deploying.git
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-deploying.git.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-deploying.git.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-deploying.git
[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-deploying.git.svg
[bd_npm_url]: http://www.npmjs.org/package/ape-deploying
[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-deploying.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Deploying module of ape framework.

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
----

### Deploy to GitHub Pages

Deploy subdirectory to GitHub Pages using git subtree.

```javascript
#!/usr/bin/env node
'use strict'

const apeDeploying = require('ape-deploying')

apeDeploying.deployGhPages('doc', {}).then(() => {
  /* ... */
})

```

### Deploy to GitHub Wiki

Deploy files to GitHub Wiki page.

```javascript
#!/usr/bin/env node
'use strict'

const apeDeploying = require('ape-deploying')

const wikiUrl = 'https://github.com/okunishinishi/node-coz.wiki.git'

apeDeploying.deployGhWiki('doc/wiki/*.md', wikiUrl, {
  clean: true
}).then(() => {
  /* ... */
})
```

<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/ape-repo/ape-deploying.git/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [ape-repo][ape_repo_url]
+ [GitHub Pages][git_hub_pages_url]

[ape_repo_url]: https://github.com/ape-repo
[git_hub_pages_url]: https://pages.github.com/

<!-- Links End -->