Skip to content
This repository has been archived by the owner on Jun 13, 2023. It is now read-only.

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
helaili committed Jan 3, 2021
1 parent 91dcb26 commit 38e2fb5
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,33 @@ Just click on the *_View deployment_* button of the `github-pages` environment t

![image](https://user-images.githubusercontent.com/2787414/51083411-188d1b00-171a-11e9-9a25-f8b06f33053e.png)

### Known Limitation
## Inputs

### jekyll_env
The Jekyll environment to build (default to `production`)

### jekyll_src
The Jekyll website source directory

### jekyll_build_options
Additional Jekyll build arguments (see [the Jekyll doc](https://jekyllrb.com/docs/configuration/options/#build-command-options))

### gem_src
The Jekyll Gemfile directory

### target_branch
The target branch name the sources get pushed to

### build_only
When set to `true`, the Jekyll site will be built but not published

## Known Limitation
Publishing of the GitHub pages can fail when using the `GITHUB_TOKEN` secret as the value of the `JEKYLL_PAT` env variable, as opposed to a Personal Access Token set as a secret. But it might work too :smile:

### I have a problem
## I have a problem
Create a `ACTIONS_STEP_DEBUG` secret with value `true` and run the workflow again.

### Note on custom domains
## Note on custom domains
If you're using a Custom Domain for your GitHub Pages site, you will need to ensure that the `CNAME` file exists in the repository root of the `main` (or `master`) branch so that it can be copied to the deployment root when your site is deployed.

If your GitHub Pages site is run off the `main` (or `master`) branch, you can modify the Custom Domain setting in the Repository Settings to automatically generate and commit the `CNAME` file.
Expand Down

0 comments on commit 38e2fb5

Please sign in to comment.