Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fstaudt/gradle-hugo-plugin
Gradle plugin for Hugo static site generator
https://github.com/fstaudt/gradle-hugo-plugin
gohugoio gradle-plugin spring-boot
Last synced: about 3 hours ago
JSON representation
Gradle plugin for Hugo static site generator
- Host: GitHub
- URL: https://github.com/fstaudt/gradle-hugo-plugin
- Owner: fstaudt
- License: apache-2.0
- Created: 2021-11-06T14:22:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T11:03:50.000Z (16 days ago)
- Last Synced: 2024-11-01T12:17:19.811Z (16 days ago)
- Topics: gohugoio, gradle-plugin, spring-boot
- Language: Kotlin
- Homepage:
- Size: 412 KB
- Stars: 14
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Gradle Hugo plugin
Wrapper for [Hugo](https://gohugo.io) static site generator.
The plugin provides a declarative approach for the Hugo binary used to build the static site.\
The requested Hugo version is downloaded and cached by Gradle to ensure that your static site is built with the right version of Hugo.
## Extension configuration
Plugin extension is available to override general configuration (default values provided below).
```kotlin
hugo {
// Hugo version
version = "0.136.2"
// Relative path to sources of Hugo site in Gradle project
sourceDirectory = "site"
// Download URL for Windows ( {0} can be used to replace version )
windowsDownloadUrl = "https://github.com/gohugoio/hugo/releases/download/v{0}/hugo_extended_{0}_windows-amd64.zip"
// Download URL for Linux ( {0} can be used to replace version )
linuxDownloadUrl = "https://github.com/gohugoio/hugo/releases/download/v{0}/hugo_extended_{0}_linux-amd64.tar.gz"
// Download URL for macOS ( {0} can be used to replace version )
macOSDownloadUrl = "https://github.com/gohugoio/hugo/releases/download/v{0}/hugo_extended_{0}_darwin-universal.tar.gz"
// Operating system family (Windows, macOS or Unix)
osFamily = io.github.fstaudt.hugo.OsFamily.CURRENT_SYSTEM // default value derived from system property "os.name"
}
```
## Tasks
### hugo
Execute any Hugo command (e.g. new, gen, check ...).
Option `command` allows to specify the Hugo command to execute.\
It defaults to `new site .`.
```shell
gradle hugo --command=check
```
### hugoServer
Run server for development of Hugo static site.
Task configuration can be overridden according to your needs (example values provided below).
```kotlin
tasks.hugoServer {
// optional baseUrl to access Hugo static site in browser (defaults to baseUrl configured in config.toml)
baseURL = "http://localhost:1313/documentation/"
// optional additional server arguments (appended to arguments generated from baseUrl)
args = "--buildDrafts --buildExpired"
}
```
:bulb: This task is configurable in build.gradle.kts and should be preferred to `hugo` task to serve Hugo static site.
### hugoBuild
Build Hugo static site for publication.
Task configuration can be overridden according to your needs (default values provided below).
```kotlin
tasks.hugoBuild {
// Output directory for build result
outputDirectory = File("$buildDir/hugo/publish")
// additional path in output directory
publicationPath = ""
// optional additional build arguments (appended to "-d" argument generated from previous properties)
args = ""
}
```
:bulb: This task is cacheable and should be preferred to `hugo` task to build Hugo static site.
### hugoDownload
Download Hugo binary for the current OS (Windows, macOS or Linux).
By default, downloaded version is Hugo extended v0.136.2.\
Downloaded version can be configured in [Extension configuration](#extension-configuration).
This task is a dependency of the previous tasks.
## Examples
- [Generation of standalone Hugo site](https://github.com/fstaudt/gradle-hugo-plugin-examples)
- [Integration with Spring Boot](https://github.com/fstaudt/gradle-hugo-plugin-examples)