Skip to content

Commit

Permalink
OOps the gh_pages typo existed for so long
Browse files Browse the repository at this point in the history
  • Loading branch information
rayluo committed Jul 29, 2023
1 parent e51b66c commit 66d1c55
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,18 @@ How to use it?
# it could be an output directory created dynamically by your static website builder.
source-directory: .

# Optional. Default value "gh_pages".
# Optional. Default value "gh-pages".
# It specifies the temporary branch which hosts the static website.
# Each build will OVERWRITE this branch.
target-branch: gh_pages
target-branch: gh-pages
```
2. In your Github Pages setting, choose your publish source to match your Github Page Overwriter (GPO) settings.
| Github Page Overwriter (GPO) settings in your workflow's yml file | Github Pages settings |
| ----------------------------------------------------------------- | --------------------- |
| `target-branch` could be any branch you want to *overwrite* with your static website. By default, it will be "gh_pages". | You MUST choose the branch that matches the `target-branch` setting on the left |
| `target-branch` could be any branch you want to *overwrite* with your static website. By default, it will be "gh-pages". | You MUST choose the branch that matches the `target-branch` setting on the left |
| `source-directory` MUST be the directory containing your "index.html" | *Always* choose folder `/ (root)` for your publishing source, regardless of what `source-directory` is. So, a typical setting looks like this: ![Choose "/ (root)" as folder](github-pages-settings.png) |


Expand Down

0 comments on commit 66d1c55

Please sign in to comment.