From 834306ba279944a8bd2c22a6c19cb6a5efdf474c Mon Sep 17 00:00:00 2001 From: Shohei Ueda <30958501+peaceiris@users.noreply.github.com> Date: Sat, 9 Oct 2021 22:04:44 +0900 Subject: [PATCH] docs: Update enable_jekyll description (#661) Close #660 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a633ba3..a58641b 100644 --- a/README.md +++ b/README.md @@ -318,7 +318,7 @@ For more details about the `CNAME` file, read the official documentation: [Manag If you want GitHub Pages to process your site with the static site generator Jekyll, set `enable_jekyll` to true. -By default, this action signals to GitHub Pages that the site shall not be processed with Jekyll. This is done by adding an empty `.nojekyll` file when publishing to the master or gh-pages branch. When a `.nojekyll` file already exists, this action does nothing. +By default, this action signals to GitHub Pages that the site shall not be processed with Jekyll. This is done by adding an empty `.nojekyll` file on your publishing branch. When that file already exists, this action does nothing. Bypassing Jekyll makes the deployment faster and is necessary if you are deploying files or directories that start with underscores, since Jekyll considers these to be special resources and does not copy them to the final site. You only need to set `enable_jekyll` to true when you want to deploy a Jekyll-powered website and let GitHub Pages do the Jekyll processing.