Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
peaceiris committed Sep 29, 2019
1 parent 76490a4 commit 9e74ae3
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ 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)
- [(2) Create `.github/workflows/gh-pages.yml`](#2-create-githubworkflowsgh-pagesyml)
- [(1) Add SSH deploy key](#1-add-ssh-deploy-key)
- [(2) Create your workflow](#2-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)
Expand All @@ -63,7 +63,7 @@ The above example step will deploy `./public` directory to `gh-pages` branch.

## Getting started

### (1) Add ssh deploy key
### (1) Add SSH deploy key

Generate your deploy key with the following command.

Expand All @@ -87,7 +87,9 @@ Next, Go to **Repository Settings**
|---|---|
| ![](./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

Expand Down

0 comments on commit 9e74ae3

Please sign in to comment.