Skip to content

Commit

Permalink
docs: Improve description of destination_dir and keep_files
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris authored Feb 16, 2021
1 parent d3a97d5 commit 4a95b89
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ For example:

### ⭐️ Keeping existing files `keep_files`

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`.
By default, existing files in the publishing directory (or `destination_dir` if you use) will be removed. If you want the action to add new files but leave existing ones untouched, set the optional parameter `keep_files` to `true`.

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.

Expand Down

0 comments on commit 4a95b89

Please sign in to comment.