docs: update readme
This commit is contained in:
parent
d46d0aa12e
commit
3bbd6d1917
10
README.md
10
README.md
|
@ -13,15 +13,15 @@
|
||||||
|
|
||||||
We can run Hugo on a virtual machine of GitHub Actions by this Hugo action. Hugo extended version and Hugo Modules are supported.
|
We can run Hugo on a virtual machine of GitHub Actions by this Hugo action. Hugo extended version and Hugo Modules are supported.
|
||||||
|
|
||||||
From `v2.0.0`, this Hugo action migrated to a JavaScript action. We no longer build or pull a Hugo docker image. Thanks to this change, we can complete this action less than **1 sec**. (Docker base action was taking about 1 min execution time to build or pull.)
|
From `v2.0.0`, this Hugo action migrated to a JavaScript action. We no longer build or pull a Hugo docker image. Thanks to this change, we can complete this action less than **2 sec**. (A docker base action was taking about 1 min or more execution time to build or pull.)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
### Create `.github/workflows/gh-pages.yml`
|
### Create your workflow
|
||||||
|
|
||||||
An example workflow with [GitHub Actions for deploying to GitHub Pages with Static Site Generators]
|
An example workflow `.github/workflows/gh-pages.yml` 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
|
[GitHub Actions for deploying to GitHub Pages with Static Site Generators]: https://github.com/peaceiris/actions-gh-pages
|
||||||
|
|
||||||
|
@ -64,7 +64,7 @@ jobs:
|
||||||
|
|
||||||
## Options
|
## Options
|
||||||
|
|
||||||
### Hugo extended
|
### Use Hugo extended
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: Setup Hugo
|
- name: Setup Hugo
|
||||||
|
@ -74,7 +74,7 @@ jobs:
|
||||||
extended: true
|
extended: true
|
||||||
```
|
```
|
||||||
|
|
||||||
### Latest version of Hugo
|
### Use the latest version of Hugo
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- name: Setup Hugo
|
- name: Setup Hugo
|
||||||
|
|
Loading…
Reference in New Issue