From e27e41d7cec17eaa1f5c90fb35857722f80a05c9 Mon Sep 17 00:00:00 2001 From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com> Date: Tue, 16 Feb 2021 20:13:09 +0900 Subject: [PATCH] docs: Improve description of destination_dir and keep_files (#569) https://github.com/peaceiris/actions-gh-pages/issues/324#issuecomment-779218091 Co-authored-by: Matthias Mohr --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e9029b7..b30696c 100644 --- a/README.md +++ b/README.md @@ -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 publish branch (or only in `destination_dir` if given) 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.