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

add: emoji to h4 heading

This commit is contained in:
peaceiris 2019-09-09 10:42:09 +09:00
parent 5ef51a859a
commit 1846d9c611
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -21,12 +21,12 @@ Table of Contents
- [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 `.github/workflows/gh-pages.yml`](#2-create-githubworkflowsgh-pagesyml)
- [Repository type - Project](#repository-type---project) - [:star: Repository type - Project](#star-repository-type---project)
- [Repository type - User and Organization](#repository-type---user-and-organization) - [:star: Repository type - User and Organization](#star-repository-type---user-and-organization)
- [Options](#options) - [Options](#options)
- [Pull action image from Docker Hub](#pull-action-image-from-docker-hub) - [:star: Pull action image from Docker Hub](#star-pull-action-image-from-docker-hub)
- [`PERSONAL_TOKEN`](#personal_token) - [:star: `PERSONAL_TOKEN`](#star-personal_token)
- [`GITHUB_TOKEN`](#github_token) - [:star: `GITHUB_TOKEN`](#star-github_token)
- [Examples](#examples) - [Examples](#examples)
- [MkDocs](#mkdocs) - [MkDocs](#mkdocs)
- [License](#license) - [License](#license)
@ -56,7 +56,7 @@ Next, Go to **Repository Settings**
### (2) Create `.github/workflows/gh-pages.yml` ### (2) Create `.github/workflows/gh-pages.yml`
#### Repository type - Project #### :star: Repository type - Project
An example yaml file with Hugo action. An example yaml file with Hugo action.
@ -94,7 +94,7 @@ jobs:
The above example is for [Project Pages sites]. (`<username>/<project_name>` repository) The above example is for [Project Pages sites]. (`<username>/<project_name>` repository)
#### Repository type - User and Organization #### :star: Repository type - User and Organization
For [User and Organization Pages sites] (`<username>/<username>.github.io` repository), For [User and Organization Pages sites] (`<username>/<username>.github.io` repository),
we have to set `master` branch to `PUBLISH_BRANCH`. we have to set `master` branch to `PUBLISH_BRANCH`.
@ -113,7 +113,7 @@ PUBLISH_BRANCH: master # deploying branch
### Options ### Options
#### Pull action image from Docker Hub #### :star: Pull action image from Docker Hub
You can pull a public docker image from Docker Hub. You can pull a public docker image from Docker Hub.
By pulling docker images, you can reduce the overall execution time of your workflow. In addition, `latest` tag is provided. By pulling docker images, you can reduce the overall execution time of your workflow. In addition, `latest` tag is provided.
@ -132,7 +132,7 @@ By pulling docker images, you can reduce the overall execution time of your work
- [peaceiris/gha-hugo - Docker Hub](https://hub.docker.com/r/peaceiris/gha-hugo) - [peaceiris/gha-hugo - Docker Hub](https://hub.docker.com/r/peaceiris/gha-hugo)
#### `PERSONAL_TOKEN` #### :star: `PERSONAL_TOKEN`
[Generate a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`. [Generate a personal access token (`repo`)](https://github.com/settings/tokens) and add it to Secrets as `PERSONAL_TOKEN`, it works as well as `ACTIONS_DEPLOY_KEY`.
@ -141,7 +141,7 @@ By pulling docker images, you can reduce the overall execution time of your work
+ PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }} + PERSONAL_TOKEN: ${{ secrets.PERSONAL_TOKEN }}
``` ```
#### `GITHUB_TOKEN` #### :star: `GITHUB_TOKEN`
> **NOTES**: This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. See #9 > **NOTES**: This action supports `GITHUB_TOKEN` but it has some problems to deploy to GitHub Pages. See #9