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 2019-09-29 17:50:32 +09:00
parent 76490a48db
commit 9e74ae3f23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -35,8 +35,8 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
- [Getting started](#getting-started) - [Getting started](#getting-started)
- [(1) Add ssh deploy key](#1-add-ssh-deploy-key) - [(1) Add SSH deploy key](#1-add-ssh-deploy-key)
- [(2) Create `.github/workflows/gh-pages.yml`](#2-create-githubworkflowsgh-pagesyml) - [(2) Create your workflow](#2-create-your-workflow)
- [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project) - [⭐️ Repository type - Project](#%EF%B8%8F-repository-type---project)
- [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization) - [⭐️ Repository type - User and Organization](#%EF%B8%8F-repository-type---user-and-organization)
- [Options](#options) - [Options](#options)
@ -63,7 +63,7 @@ The above example step will deploy `./public` directory to `gh-pages` branch.
## Getting started ## Getting started
### (1) Add ssh deploy key ### (1) Add SSH deploy key
Generate your deploy key with the following command. Generate your deploy key with the following command.
@ -87,7 +87,9 @@ Next, Go to **Repository Settings**
|---|---| |---|---|
| ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) | | ![](./images/secrets-1.jpg) | ![](./images/secrets-2.jpg) |
### (2) Create `.github/workflows/gh-pages.yml` ### (2) Create your workflow
Add your workflow setting YAML file `.github/workflows/gh-pages.yml` and push to the default branch.
#### ⭐️ Repository type - Project #### ⭐️ Repository type - Project