Skip to content

Commit a5f6b56

Browse files
author
Sergio Abreu García
committed
Added 'remove' documentation to 'readme.md'
1 parent 0249ac9 commit a5f6b56

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

readme.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,22 @@ ghpages.publish('dist', {
227227
}, callback);
228228
```
229229

230+
#### <a id="optionsuser">options.remove</a>
231+
* type: `string`
232+
* default: `'.'`
233+
234+
Removes files that match the given pattern (Ignored if used together with
235+
`--add`). By default, `gh-pages` removes everything inside the target branch
236+
auto-generated directory before copying the new files from `dir`.
237+
238+
Example use of the `remove` option:
239+
240+
```js
241+
ghpages.publish('dist', {
242+
remove: "*.json"
243+
}, callback);
244+
```
245+
230246

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

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

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

0 commit comments

Comments
 (0)