Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brocessing/ghp
:package: Automagically deploy your app on Github pages
https://github.com/brocessing/ghp
deployment github-pages static-site
Last synced: 3 months ago
JSON representation
:package: Automagically deploy your app on Github pages
- Host: GitHub
- URL: https://github.com/brocessing/ghp
- Owner: brocessing
- License: mit
- Created: 2017-02-08T23:44:18.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T15:50:20.000Z (over 2 years ago)
- Last Synced: 2024-10-31T14:14:22.626Z (3 months ago)
- Topics: deployment, github-pages, static-site
- Language: JavaScript
- Homepage: https://brocessing.github.io/ghp/
- Size: 88.9 KB
- Stars: 8
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ghp
Automagically deploy your app on Github pages
## CLI
### installation
```sh
npm install -g ghp
```
### usage
```
ghp
ghp DIRECTORY
ghp DIRECTORY --force
ghp DIRECTORY --cache
ghp DIRECTORY --message
ghp DIRECTORY --branch gh-pages
ghp DIRECTORY --append
ghp --help
Options:
-h, --help Show this screen.
-b, --branch=
Specify the branch to deploy to (default: gh-pages).
-m, --message= Use the given as the commit message.
-a, --append= Copy to the pushed directory another directory.
-f, --force Deploy without checking for uncommited changes.
-q, --quiet Suppress step summary messages.
-c, --cache= Specify a cache directory.
```
## Node.js
### installation
```sh
npm install -S ghp
```
### usage
```js
var ghp = require('ghp')
ghp.deploy(path, options)
```
### options
+ **`options.branch`**
+ branch to deploy to
+ *default `'gh-pages'`*
+ **`options.message`**
+ commit message for the gh-pages branch
+ *default `':package: Update gh-pages'`*
+ **`options.append`**
+ append to the root of the pushed directory another path
+ *default `false`*
+ **`options.quiet`**
+ suppress step summary messages
+ *default `false`*
+ **`options.force`**
+ skip the uncommited changes step
+ *default `false`*
+ **`options.cwd`**
+ git cwd
+ *default `process.cwd()`*
## License
[MIT](https://tldrlegal.com/license/mit-license).