Merge commit '5be51ac3db225d5df501ed1fa1499c41d97dbf65'

This commit is contained in:
Bjørn Erik Pedersen
2025-04-10 13:04:51 +02:00
987 changed files with 12379 additions and 14083 deletions

View File

@@ -1,16 +0,0 @@
---
_comment: Do not remove front matter.
---
Hugo is available in three editions: standard, extended, and extended/deploy. While the standard edition provides core functionality, the extended and extended/deploy editions offer advanced features.
Feature|extended edition|extended/deploy edition
:--|:-:|:-:
Encode to the WebP format when [processing images]. You can decode WebP images with any edition.|:heavy_check_mark:|:heavy_check_mark:
[Transpile Sass to CSS] using the embedded LibSass transpiler. You can use the [Dart Sass] transpiler with any edition.|:heavy_check_mark:|:heavy_check_mark:
Deploy your site directly to a Google Cloud Storage bucket, an AWS S3 bucket, or an Azure Storage container. See [details].|:x:|:heavy_check_mark:
[dart sass]: /functions/css/sass/#dart-sass
[processing images]: /content-management/image-processing/
[transpile sass to css]: /functions/css/sass/
[details]: /hosting-and-deployment/hugo-deploy/

View File

@@ -1,40 +0,0 @@
---
_comment: Do not remove front matter.
---
## Prerequisites
Although not required in all cases, [Git], [Go], and [Dart Sass] are commonly used when working with Hugo.
Git is required to:
- Build Hugo from source
- Use the [Hugo Modules] feature
- Install a theme as a Git submodule
- Access [commit information] from a local Git repository
- Host your site with services such as [CloudCannon], [Cloudflare Pages], [GitHub Pages], [GitLab Pages], and [Netlify]
Go is required to:
- Build Hugo from source
- Use the Hugo Modules feature
Dart Sass is required to transpile Sass to CSS when using the latest features of the Sass language.
Please refer to the relevant documentation for installation instructions:
- [Git][git install]
- [Go][go install]
- [Dart Sass][dart sass install]
[cloudcannon]: https://cloudcannon.com/
[cloudflare pages]: https://pages.cloudflare.com/
[dart sass install]: /functions/css/sass/#dart-sass
[dart sass]: https://sass-lang.com/dart-sass
[git install]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
[git]: https://git-scm.com/
[github pages]: https://pages.github.com/
[gitlab pages]: https://docs.gitlab.com/ee/user/project/pages/
[go install]: https://go.dev/doc/install
[go]: https://go.dev/
[netlify]: https://www.netlify.com/

View File

@@ -1,23 +0,0 @@
---
_comment: Do not remove front matter.
---
## Prebuilt binaries
Prebuilt binaries are available for a variety of operating systems and architectures. Visit the [latest release] page, and scroll down to the Assets section.
1. Download the archive for the desired edition, operating system, and architecture
1. Extract the archive
1. Move the executable to the desired directory
1. Add this directory to the PATH environment variable
1. Verify that you have _execute_ permission on the file
Please consult your operating system documentation if you need help setting file permissions or modifying your PATH environment variable.
If you do not see a prebuilt binary for the desired edition, operating system, and architecture, install Hugo using one of the methods described below.
[commit information]: /methods/page/gitinfo/
[Git]: https://git-scm.com/
[Go]: https://go.dev/
[Hugo Modules]: /hugo-modules/
[latest release]: https://github.com/gohugoio/hugo/releases/latest

View File

@@ -1,38 +0,0 @@
---
_comment: Do not remove front matter.
---
## Build from source
To build the extended or extended/deploy edition from source you must:
1. Install [Git]
1. Install [Go] version 1.20 or later
1. Install a C compiler, either [GCC] or [Clang]
1. Update your `PATH` environment variable as described in the [Go documentation]
> The install directory is controlled by the `GOPATH` and `GOBIN` environment variables. If `GOBIN` is set, binaries are installed to that directory. If `GOPATH` is set, binaries are installed to the bin subdirectory of the first directory in the `GOPATH` list. Otherwise, binaries are installed to the bin subdirectory of the default `GOPATH` (`$HOME/go` or `%USERPROFILE%\go`).
To build the standard edition:
```sh
go install github.com/gohugoio/hugo@latest
```
To build the extended edition:
```sh
CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest
```
To build the extended/deploy edition:
```sh
CGO_ENABLED=1 go install -tags extended,withdeploy github.com/gohugoio/hugo@latest
```
[Clang]: https://clang.llvm.org/
[GCC]: https://gcc.gnu.org/
[Git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
[Go documentation]: https://go.dev/doc/code#Command
[Go]: https://go.dev/doc/install

View File

@@ -1,13 +0,0 @@
---
cascade:
_build:
list: never
publishResources: false
render: never
---
<!--
Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required.
Include the rendered content using the "include" shortcode.
-->

View File

@@ -1,13 +0,0 @@
---
_comment: Do not remove front matter.
---
### Homebrew
[Homebrew] is a free and open-source package manager for macOS and Linux. To install the extended edition of Hugo:
```sh
brew install hugo
```
[Homebrew]: https://brew.sh/

View File

@@ -1,16 +1,8 @@
---
title: Installation
description: Install Hugo on macOS, Linux, Windows, BSD, and on any machine that can run the Go compiler tool chain.
aliases: [/getting-started/installing/]
categories: []
keywords: []
menu:
docs:
identifier: installation-in-this-section
parent: installation
weight: 10
weight: 10
aliases: [/getting-started/installing/]
---
Install Hugo on macOS, Linux, Windows, BSD, and on any machine that can run the Go compiler tool chain.

View File

@@ -1,25 +1,20 @@
---
title: BSD
description: Install Hugo on BSD derivatives.
categories: [installation]
categories: []
keywords: []
menu:
docs:
parent: installation
weight: 50
weight: 50
toc: true
weight: 40
---
## Editions
{{% include "installation/_common/01-editions.md" %}}
{{% include "/_common/installation/01-editions.md" %}}
Unless your specific deployment needs require the extended/deploy edition, we recommend the extended edition.
{{% include "installation/_common/02-prerequisites.md" %}}
{{% include "/_common/installation/02-prerequisites.md" %}}
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
{{% include "/_common/installation/03-prebuilt-binaries.md" %}}
## Repository packages
@@ -67,7 +62,7 @@ doas pkg_add hugo
[OpenBSD]: https://www.openbsd.org/
{{% include "installation/_common/04-build-from-source.md" %}}
{{% include "/_common/installation/04-build-from-source.md" %}}
## Comparison

View File

@@ -1,25 +1,20 @@
---
title: Linux
description: Install Hugo on Linux.
categories: [installation]
categories: []
keywords: []
menu:
docs:
parent: installation
weight: 30
weight: 30
toc: true
weight: 20
---
## Editions
{{% include "installation/_common/01-editions.md" %}}
{{% include "/_common/installation/01-editions.md" %}}
Unless your specific deployment needs require the extended/deploy edition, we recommend the extended edition.
{{% include "installation/_common/02-prerequisites.md" %}}
{{% include "/_common/installation/02-prerequisites.md" %}}
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
{{% include "/_common/installation/03-prebuilt-binaries.md" %}}
## Package managers
@@ -27,7 +22,7 @@ Unless your specific deployment needs require the extended/deploy edition, we re
[Snap] is a free and open-source package manager for Linux. Available for [most distributions], snap packages are simple to install and are automatically updated.
The Hugo snap package is [strictly confined]. Strictly confined snaps run in complete isolation, up to a minimal access level thats deemed always safe. The sites you create and build must be located within your home directory, or on removable media.
The Hugo snap package is [strictly confined]. Strictly confined snaps run in complete isolation, up to a minimal access level that's deemed always safe. The sites you create and build must be located within your home directory, or on removable media.
To install the extended edition of Hugo:
@@ -49,23 +44,16 @@ sudo snap connect hugo:ssh-keys
sudo snap disconnect hugo:ssh-keys
```
[most distributions]: https://snapcraft.io/docs/installing-snapd
[strictly confined]: https://snapcraft.io/docs/snap-confinement
[Snap]: https://snapcraft.io/
{{% include "installation/_common/homebrew.md" %}}
{{% include "/_common/installation/homebrew.md" %}}
## Repository packages
Most Linux distributions maintain a repository for commonly installed applications.
{{% note %}}
The Hugo version available in package repositories varies based on Linux distribution and release, and in some cases will not be the [latest version].
Use one of the other installation methods if your package repository does not provide the desired version.
[latest version]: https://github.com/gohugoio/hugo/releases/latest
{{% /note %}}
> [!note]
> The Hugo version available in package repositories varies based on Linux distribution and release, and in some cases will not be the [latest version].
>
> Use one of the other installation methods if your package repository does not provide the desired version.
### Alpine Linux
@@ -75,8 +63,6 @@ To install the extended edition of Hugo on [Alpine Linux]:
doas apk add --no-cache --repository=https://dl-cdn.alpinelinux.org/alpine/edge/community hugo
```
[Alpine Linux]: https://alpinelinux.org/
### Arch Linux
Derivatives of the [Arch Linux] distribution of Linux include [EndeavourOS], [Garuda Linux], [Manjaro], and others. To install the extended edition of Hugo:
@@ -85,11 +71,6 @@ Derivatives of the [Arch Linux] distribution of Linux include [EndeavourOS], [Ga
sudo pacman -S hugo
```
[Arch Linux]: https://archlinux.org/
[EndeavourOS]: https://endeavouros.com/
[Manjaro]: https://manjaro.org/
[Garuda Linux]: https://garudalinux.org/
### Debian
Derivatives of the [Debian] distribution of Linux include [elementary OS], [KDE neon], [Linux Lite], [Linux Mint], [MX Linux], [Pop!_OS], [Ubuntu], [Zorin OS], and others. To install the extended edition of Hugo:
@@ -100,33 +81,22 @@ sudo apt install hugo
You can also download Debian packages from the [latest release] page.
[Debian]: https://www.debian.org/
[Exherbo]: https://www.exherbolinux.org/
[elementary OS]: https://elementary.io/
[KDE neon]: https://neon.kde.org/
[Linux Lite]: https://www.linuxliteos.com/
[Linux Mint]: https://linuxmint.com/
[MX Linux]: https://mxlinux.org/
[Pop!_OS]: https://pop.system76.com/
[Ubuntu]: https://ubuntu.com/
[Zorin OS]: https://zorin.com/os/
### Exherbo
To install the extended edition of Hugo on [Exherbo]:
1. Add this line to /etc/paludis/options.conf:
```text
www-apps/hugo extended
```
```text
www-apps/hugo extended
```
1. Install using the Paludis package manager:
```sh
cave resolve -x repository/heirecka
cave resolve -x hugo
```
```sh
cave resolve -x repository/heirecka
cave resolve -x hugo
```
### Fedora
@@ -136,10 +106,6 @@ Derivatives of the [Fedora] distribution of Linux include [CentOS], [Red Hat Ent
sudo dnf install hugo
```
[CentOS]: https://www.centos.org/
[Fedora]: https://getfedora.org/
[Red Hat Enterprise Linux]: https://www.redhat.com/
### Gentoo
Derivatives of the [Gentoo] distribution of Linux include [Calculate Linux], [Funtoo], and others. To install the extended edition of Hugo:
@@ -156,11 +122,6 @@ Derivatives of the [Gentoo] distribution of Linux include [Calculate Linux], [Fu
sudo emerge www-apps/hugo
```
[Calculate Linux]: https://www.calculate-linux.org/
[Funtoo]: https://www.funtoo.org/
[Gentoo]: https://www.gentoo.org/
[USE]: https://packages.gentoo.org/packages/www-apps/hugo
### NixOS
The NixOS distribution of Linux includes Hugo in its package repository. To install the extended edition of Hugo:
@@ -177,10 +138,6 @@ Derivatives of the [openSUSE] distribution of Linux include [GeckoLinux], [Linux
sudo zypper install hugo
```
[GeckoLinux]: https://geckolinux.github.io/
[Linux Karmada]: https://linuxkamarada.com/
[openSUSE]: https://www.opensuse.org/
### Solus
The [Solus] distribution of Linux includes Hugo in its package repository. To install the extended edition of Hugo:
@@ -189,8 +146,6 @@ The [Solus] distribution of Linux includes Hugo in its package repository. To in
sudo eopkg install hugo
```
[Solus]: https://getsol.us/
### Void Linux
To install the extended edition of Hugo on [Void Linux]:
@@ -199,9 +154,7 @@ To install the extended edition of Hugo on [Void Linux]:
sudo xbps-install -S hugo
```
[Void Linux]: https://voidlinux.org/
{{% include "installation/_common/04-build-from-source.md" %}}
{{% include "/_common/installation/04-build-from-source.md" %}}
## Comparison
@@ -215,3 +168,35 @@ Latest version available?|:heavy_check_mark:|:heavy_check_mark:|varies|:heavy_ch
[^1]: Easy if a previous version is still installed.
[^2]: Snap packages are automatically updated. Homebrew requires advanced configuration.
[Alpine Linux]: https://alpinelinux.org/
[Arch Linux]: https://archlinux.org/
[Calculate Linux]: https://www.calculate-linux.org/
[CentOS]: https://www.centos.org/
[Debian]: https://www.debian.org/
[elementary OS]: https://elementary.io/
[EndeavourOS]: https://endeavouros.com/
[Exherbo]: https://www.exherbolinux.org/
[Fedora]: https://getfedora.org/
[Funtoo]: https://www.funtoo.org/
[Garuda Linux]: https://garudalinux.org/
[GeckoLinux]: https://geckolinux.github.io/
[Gentoo]: https://www.gentoo.org/
[KDE neon]: https://neon.kde.org/
[latest version]: https://github.com/gohugoio/hugo/releases/latest
[Linux Karmada]: https://linuxkamarada.com/
[Linux Lite]: https://www.linuxliteos.com/
[Linux Mint]: https://linuxmint.com/
[Manjaro]: https://manjaro.org/
[most distributions]: https://snapcraft.io/docs/installing-snapd
[MX Linux]: https://mxlinux.org/
[openSUSE]: https://www.opensuse.org/
[Pop!_OS]: https://pop.system76.com/
[Red Hat Enterprise Linux]: https://www.redhat.com/
[Snap]: https://snapcraft.io/
[Solus]: https://getsol.us/
[strictly confined]: https://snapcraft.io/docs/snap-confinement
[Ubuntu]: https://ubuntu.com/
[USE]: https://packages.gentoo.org/packages/www-apps/hugo
[Void Linux]: https://voidlinux.org/
[Zorin OS]: https://zorin.com/os/

View File

@@ -1,29 +1,24 @@
---
title: macOS
description: Install Hugo on macOS.
categories: [installation]
categories: []
keywords: []
menu:
docs:
parent: installation
weight: 20
weight: 20
toc: true
weight: 10
---
## Editions
{{% include "installation/_common/01-editions.md" %}}
{{% include "/_common/installation/01-editions.md" %}}
Unless your specific deployment needs require the extended/deploy edition, we recommend the extended edition.
{{% include "installation/_common/02-prerequisites.md" %}}
{{% include "/_common/installation/02-prerequisites.md" %}}
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
{{% include "/_common/installation/03-prebuilt-binaries.md" %}}
## Package managers
{{% include "installation/_common/homebrew.md" %}}
{{% include "/_common/installation/homebrew.md" %}}
### MacPorts
@@ -35,7 +30,7 @@ sudo port install hugo
[MacPorts]: https://www.macports.org/
{{% include "installation/_common/04-build-from-source.md" %}}
{{% include "/_common/installation/04-build-from-source.md" %}}
## Comparison

View File

@@ -1,29 +1,23 @@
---
title: Windows
description: Install Hugo on Windows.
categories: [installation]
categories: []
keywords: []
menu:
docs:
parent: installation
weight: 40
weight: 40
toc: true
weight: 30
---
{{% note %}}
Hugo v0.121.1 and later require at least Windows 10 or Windows Server 2016.
{{% /note %}}
> [!note]
> Hugo v0.121.1 and later require at least Windows 10 or Windows Server 2016.
## Editions
{{% include "installation/_common/01-editions.md" %}}
{{% include "/_common/installation/01-editions.md" %}}
Unless your specific deployment needs require the extended/deploy edition, we recommend the extended edition.
{{% include "installation/_common/02-prerequisites.md" %}}
{{% include "/_common/installation/02-prerequisites.md" %}}
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
{{% include "/_common/installation/03-prebuilt-binaries.md" %}}
## Package managers
@@ -35,8 +29,6 @@ Unless your specific deployment needs require the extended/deploy edition, we re
choco install hugo-extended
```
[Chocolatey]: https://chocolatey.org/
### Scoop
[Scoop] is a free and open-source package manager for Windows. To install the extended edition of Hugo:
@@ -45,8 +37,6 @@ choco install hugo-extended
scoop install hugo-extended
```
[Scoop]: https://scoop.sh/
### Winget
[Winget] is Microsoft's official free and open-source package manager for Windows. To install the extended edition of Hugo:
@@ -61,13 +51,10 @@ To uninstall the extended edition of Hugo:
winget uninstall --name "Hugo (Extended)"
```
[Winget]: https://learn.microsoft.com/en-us/windows/package-manager/
{{% include "/_common/installation/04-build-from-source.md" %}}
{{% include "installation/_common/04-build-from-source.md" %}}
{{% note %}}
See these [detailed instructions](https://discourse.gohugo.io/t/41370) to install GCC on Windows.
{{% /note %}}
> [!note]
> See these [detailed instructions](https://discourse.gohugo.io/t/41370) to install GCC on Windows.
## Comparison
@@ -81,3 +68,7 @@ Latest version available?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mar
[^1]: Possible but requires advanced configuration.
[^2]: Easy if a previous version is still installed.
[Chocolatey]: https://chocolatey.org/
[Scoop]: https://scoop.sh/
[Winget]: https://learn.microsoft.com/en-us/windows/package-manager/