status-im
/
actions-gh-pages
mirror of https://github.com/status-im/actions-gh-pages.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update

This commit is contained in:
peaceiris 2020-02-24 19:48:18 +09:00
parent 62e7849d7a
commit 7b12ca9aeb
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -61,7 +61,6 @@ Three tokens are supported.
- [Getting started](#getting-started)
- [Create your workflow](#create-your-workflow)
- [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
- [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
- [Options](#options)
@ -97,11 +96,9 @@ Three tokens are supported.
## Getting started
### Create your workflow
### ⭐️ Repository type - Project
Add your workflow setting YAML file `.github/workflows/gh-pages.yml` and push to the default branch.
#### ⭐️ Repository type - Project
Add your workflow file `.github/workflows/gh-pages.yml` and push to the remote master branch.
An example workflow for Hugo.
@ -150,7 +147,7 @@ The above example is for [Project Pages sites]. (`<username>/<project_name>` rep
|---|---|
| ![](./images/log3.jpg) | ![](./images/log4.jpg) |
#### ⭐️ Repository type - User and Organization
### ⭐️ Repository type - User and Organization
For [User and Organization Pages sites] (`<username>/<username>.github.io` repository),
we have to set `master` branch to `publish_branch`.