Skip to content

Commit b76751b

Browse files
authored
docs: improve description of enable_jekyll=disable_nojekyll (see #130) (#132)
This assumes `enable_jekyll` is implemented as (the preferred) alias for `disable_nojekyll` Close #130
1 parent dc1169c commit b76751b

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Three tokens are supported.
6767
- [⭐️ `deploy_key`](#%EF%B8%8F-deploy_key)
6868
- [⭐️ `personal_token`](#%EF%B8%8F-personal_token)
6969
- [⭐️ CNAME](#%EF%B8%8F-cname)
70-
- [⭐️ Disable `.nojekyll`](#%EF%B8%8F-disable-nojekyll)
70+
- [⭐️ Enable Jekyll](#%EF%B8%8F-enable-jekyll)
7171
- [⭐️ Allow empty commits](#%EF%B8%8F-allow-empty-commits)
7272
- [⭐️ Keeping existing files](#%EF%B8%8F-keeping-existing-files)
7373
- [⭐️ Deploy to external repository](#%EF%B8%8F-deploy-to-external-repository)
@@ -231,19 +231,22 @@ For more details about `CNAME`, read the official documentation: [Managing a cus
231231
cname: github.com
232232
```
233233

234-
### ⭐️ Disable `.nojekyll`
234+
### ⭐️ Enable Jekyll
235235

236-
By default, this action adds the `.nojekyll` file to only the `master` and `gh-pages` branches. When the file already exists, this action does nothing.
236+
If you want GitHub Pages to process the site with the static site generator Jekyll, set `enable_jekyll` to true.
237+
238+
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.
239+
240+
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.
237241

238-
To disable this behavior, we can set the `disable_nojekyll` option to `true`.
239242

240243
```yaml
241244
- name: Deploy
242245
uses: peaceiris/actions-gh-pages@v3
243246
with:
244247
github_token: ${{ secrets.GITHUB_TOKEN }}
245248
publish_dir: ./public
246-
disable_nojekyll: true
249+
enable_jekyll: true
247250
```
248251

249252
For more details about `.nojekyll`: [Bypassing Jekyll on GitHub Pages - The GitHub Blog](https://github.blog/2009-12-29-bypassing-jekyll-on-github-pages/)

0 commit comments

Comments
 (0)