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

docs: Update README

This commit is contained in:
peaceiris 2019-09-16 07:50:57 +09:00
parent e34825e78a
commit ebaa91f383
1 changed files with 38 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -1,10 +1,9 @@
[![license](https://img.shields.io/github/license/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/blob/master/LICENSE)
[![release](https://img.shields.io/github/release/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/releases/latest)
[![GitHub release date](https://img.shields.io/github/release-date/peaceiris/actions-hugo.svg)](https://github.com/peaceiris/actions-hugo/releases)
[![GitHub Actions status](https://github.com/peaceiris/actions-hugo/workflows/Push%20workflow/badge.svg)](https://github.com/peaceiris/actions-hugo/actions)
[![Docker Hub Build Status](https://img.shields.io/docker/cloud/build/peaceiris/gha-hugo.svg)](https://hub.docker.com/r/peaceiris/gha-hugo)
[![GitHub Actions status](https://github.com/peaceiris/actions-hugo/workflows/.github/workflows/test.yml/badge.svg)](https://github.com/peaceiris/actions-hugo/actions)
<img width="400" alt="GitHub Actions for Hugo extended" src="./images/ogp.svg">
<img width="400" alt="GitHub Actions for Hugo" src="./images/ogp.svg">
@ -18,7 +17,7 @@
### Create `.github/workflows/gh-pages.yml`
An example with [GitHub Actions for deploying to GitHub Pages with Static Site Generators]
An example workflow with [GitHub Actions for deploying to GitHub Pages with Static Site Generators]
[GitHub Actions for deploying to GitHub Pages with Static Site Generators]: https://github.com/peaceiris/actions-gh-pages
@ -41,13 +40,16 @@ jobs:
steps:
- uses: actions/checkout@master
- name: build
uses: peaceiris/actions-hugo@v0.58.2
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.0.0
with:
args: --gc --minify --cleanDestinationDir
hugo-version: '0.58.2'
- name: deploy
uses: peaceiris/actions-gh-pages@v2.2.0
- name: Build
run: hugo --gc --minify --cleanDestinationDir
- name: Deploy
uses: peaceiris/actions-gh-pages@v2.3.1
env:
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
PUBLISH_BRANCH: gh-pages
@ -56,6 +58,33 @@ jobs:
## Options
### Hugo extended
```yaml
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.0.0
with:
hugo-version: '0.58.2'
extended: true
```
### Latest version of Hugo
```yaml
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2.0.0
with:
hugo-version: 'latest'
```
**Note**: This action gets a Hugo latest version by GitHub API. Please be aware of [GitHub API Rate limiting]
[GitHub API Rate limiting]: https://developer.github.com/v3/#rate-limiting
## License
- [MIT License - peaceiris/actions-hugo]