Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added 'remove' documentation to the readme #319

Merged
merged 1 commit into from
Jan 7, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,22 @@ ghpages.publish('dist', {
}, callback);
```

#### <a id="optionsuser">options.remove</a>
* type: `string`
* default: `'.'`

Removes files that match the given pattern (Ignored if used together with
`--add`). By default, `gh-pages` removes everything inside the target branch
auto-generated directory before copying the new files from `dir`.

Example use of the `remove` option:

```js
ghpages.publish('dist', {
remove: "*.json"
}, callback);
```


#### <a id="optionspush">options.push</a>
* type: `boolean`
Expand Down Expand Up @@ -325,7 +341,7 @@ Note that this plugin requires Git 1.9 or higher (because it uses the `--exit-co
```

When processing `gh-pages` module generate file in`.cache/` and if stuck some reason like wrong password
it will not automatically cleanup
it will not automatically cleanup

Run `~node_modules/gh-pages/bin/gh-pages-clean`
or remove `~node_modules/gh-pages/.cache`