Skip to content

Commit c77e4d0

Browse files
committed
docs: add notes about keep_files
Note that users who are using a Static Site Generator do not need this option in most cases. Please reconsider your project structure and building scripts, or use a built-in feature of a Static Site Generator before you enable this flag. - [Static Files | Hugo](https://gohugo.io/content-management/static-files/) - [Using the Static Folder | Gatsby](https://www.gatsbyjs.com/docs/static-folder/) Related issues: - #507 - #509
1 parent 5c575e8 commit c77e4d0

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,11 @@ For example:
332332

333333
By default, existing files in the publish branch are removed before adding the ones from publish dir. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`.
334334

335+
Note that users who are using a Static Site Generator do not need this option in most cases. Please reconsider your project structure and building scripts, or use a built-in feature of a Static Site Generator before you enable this flag.
336+
337+
- [Static Files | Hugo](https://gohugo.io/content-management/static-files/)
338+
- [Using the Static Folder | Gatsby](https://www.gatsbyjs.com/docs/static-folder/)
339+
335340
For example:
336341

337342
```yaml

0 commit comments

Comments
 (0)