Skip to content

Commit

Permalink
docs: Add link to example
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Mar 16, 2020
1 parent 1ee7d6e commit c50f9fd
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,8 @@ For more details about `CNAME`, read the official documentation: [Managing a cus

If you want GitHub Pages to process the site with the static site generator Jekyll, set `enable_jekyll` to true.

[github/personal-website](https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-githubpersonal-website) is one of the examples using GitHub Pages built-in Jekyll.

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.

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.
Expand Down

0 comments on commit c50f9fd

Please sign in to comment.