You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- [⭐️ 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
231
231
cname: github.com
232
232
```
233
233
234
-
### ⭐️ Disable `.nojekyll`
234
+
### ⭐️ Enable Jekyll
235
235
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.
237
241
238
-
To disable this behavior, we can set the `disable_nojekyll` option to `true`.
239
242
240
243
```yaml
241
244
- name: Deploy
242
245
uses: peaceiris/actions-gh-pages@v3
243
246
with:
244
247
github_token: ${{ secrets.GITHUB_TOKEN }}
245
248
publish_dir: ./public
246
-
disable_nojekyll: true
249
+
enable_jekyll: true
247
250
```
248
251
249
252
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