actions-hugo/README.md

70 lines
2.4 KiB
Markdown
Raw Normal View History

2019-05-21 20:57:34 +00:00
[![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)
2019-09-02 10:23:11 +00:00
[![Docker Hub Build Status](https://img.shields.io/docker/cloud/build/peaceiris/gha-hugo.svg)](https://hub.docker.com/r/peaceiris/gha-hugo)
2019-05-21 20:57:34 +00:00
2019-05-21 21:05:36 +00:00
<img width="400" alt="GitHub Actions for Hugo extended" src="./images/ogp.svg">
2019-05-21 20:57:34 +00:00
## GitHub Actions for Hugo extended and Modules
2019-05-21 20:57:34 +00:00
- [gohugoio/hugo: The worlds fastest framework for building websites.](https://github.com/gohugoio/hugo)
## Getting started
### Create `.github/workflows/gh-pages.yml`
2019-05-21 20:57:34 +00:00
An example 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
[![peaceiris/actions-gh-pages - GitHub](https://gh-card.dev/repos/peaceiris/actions-gh-pages.svg?fullname)](https://github.com/peaceiris/actions-gh-pages)
![peaceiris/actions-hugo latest version](https://img.shields.io/github/release/peaceiris/actions-hugo.svg?label=peaceiris%2Factions-hugo)
![peaceiris/actions-gh-pages latest version](https://img.shields.io/github/release/peaceiris/actions-gh-pages.svg?label=peaceiris%2Factions-gh-pages)
```yaml
2019-08-21 20:03:19 +00:00
name: github pages
on:
push:
branches:
- master
jobs:
build-deploy:
2019-08-21 17:54:38 +00:00
runs-on: ubuntu-18.04
steps:
- uses: actions/checkout@master
2019-09-04 16:50:24 +00:00
- name: build
2019-09-14 20:24:34 +00:00
uses: peaceiris/actions-hugo@v0.58.2
with:
args: --gc --minify --cleanDestinationDir
2019-09-04 16:50:24 +00:00
- name: deploy
uses: peaceiris/actions-gh-pages@v2.2.0
env:
2019-09-05 18:09:36 +00:00
ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: ./public
2019-05-21 20:57:34 +00:00
```
## License
- [MIT License - peaceiris/actions-hugo]
2019-05-21 20:57:34 +00:00
[MIT License - peaceiris/actions-hugo]: https://github.com/peaceiris/actions-hugo/blob/master/LICENSE
2019-05-22 12:01:05 +00:00
## About the author
- [peaceiris's homepage](https://peaceiris.com/)