| name | hugo-runner |
| description | Guide for running Hugo static site generator. This skill should be used when users want to test changes. |
Hugo
Overview
Hugo converts source files from content formats to output formats. In production it only creates files. For development it has an integrated webserver.
The conversion from content to output is controlled by configuration and template files.
The docs are at https://gohugo.io/documentation/
Preparation Before Run
-
If a specific Hugo version is required use hvm to install it in the working directory; this also applies to version keywords like latest, oldest, minimal
latest is supported by hvm. If the user requiers oldest or minimal, look into theme.toml under module.hugoVersion.min:
hvm use latest - Use the latest Hugo versionhvm use 0.141.0 - Use a specific version if minimal version is 0.141.0
Usage
Run the webserver for testing changes.
Run the Webserver
Run the webserver on Hugo's on a non-default port of 3131.
cd <directory-of-content-directory> && hugo server -p 3131
To run Hugo on the default port 1313 (which is often blocked)
cd <directory-of-content-directory> && hugo server
Parameters Help
If you need a full understanding of all available parameters
hugo help
Usage Notes
- Always run Hugo from inside the working directory
- Access the site at http://localhost:3131
- The files that Hugo generates and afterwards serves are stored in
public of the working directory
- Source Markdown files of
content/* can be accessed as their output representation by http://localhost:3131/* or public/*
- Press Ctrl+C to stop the server
- Watch stdout/stderr for build warnings and errors
