Skip to content

Commit

Permalink
Merge pull request #319 from Sag-Dev/master
Browse files Browse the repository at this point in the history
Added 'remove' documentation to the readme
  • Loading branch information
tschaub authored Jan 7, 2020
2 parents ff212fe + a5f6b56 commit 169f29b
Showing 1 changed file with 17 additions and 1 deletion.
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 @@ -338,7 +354,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`

0 comments on commit 169f29b

Please sign in to comment.