mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-20 21:31:32 +02:00
Bjørn Erik Pedersen
@@ -1,16 +0,0 @@
|
||||
---
|
||||
# Do not remove front matter.
|
||||
---
|
||||
|
||||
## Editions
|
||||
|
||||
Hugo is available in two editions: standard and extended. With the extended edition you can:
|
||||
|
||||
- Encode to the WebP format when [processing images]. You can decode WebP images with either edition.
|
||||
- [Transpile Sass to CSS] using the embedded LibSass transpiler. The extended edition is not required to use the [Dart Sass] transpiler.
|
||||
|
||||
We recommend that you install the extended edition.
|
||||
|
||||
[dart sass]: /hugo-pipes/transpile-sass-to-css/#dart-sass
|
||||
[processing images]: /content-management/image-processing/
|
||||
[transpile sass to css]: /hugo-pipes/transpile-sass-to-css/
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
# 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]: /hugo-pipes/transpile-sass-to-css/#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/
|
||||
@@ -1,23 +0,0 @@
|
||||
---
|
||||
# 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]: /variables/git
|
||||
[Git]: https://git-scm.com/
|
||||
[Go]: https://go.dev/
|
||||
[Hugo Modules]: /hugo-modules/
|
||||
[latest release]: https://github.com/gohugoio/hugo/releases/latest
|
||||
@@ -1,27 +0,0 @@
|
||||
---
|
||||
# Do not remove front matter.
|
||||
---
|
||||
|
||||
## Build from source
|
||||
|
||||
To build the extended edition of Hugo 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`).
|
||||
|
||||
Then build and test:
|
||||
|
||||
```sh
|
||||
CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest
|
||||
hugo version
|
||||
```
|
||||
|
||||
[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
|
||||
@@ -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.
|
||||
-->
|
||||
@@ -1,13 +0,0 @@
|
||||
---
|
||||
# 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/
|
||||
@@ -1,16 +0,0 @@
|
||||
---
|
||||
title: Installation
|
||||
linkTitle: Overview
|
||||
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-overview
|
||||
parent: installation
|
||||
weight: 10
|
||||
weight: 10
|
||||
---
|
||||
|
||||
Install Hugo on macOS, Linux, Windows, BSD, and on any machine that can run the Go compiler tool chain.
|
||||
@@ -1,75 +0,0 @@
|
||||
---
|
||||
title: BSD
|
||||
description: Install Hugo on BSD derivatives.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 50
|
||||
weight: 50
|
||||
toc: true
|
||||
---
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
{{% include "installation/_common/02-prerequisites.md" %}}
|
||||
|
||||
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
|
||||
|
||||
## Repository packages
|
||||
|
||||
Most BSD derivatives maintain a repository for commonly installed applications. Please note that these repositories may not contain the [latest release].
|
||||
|
||||
[latest release]: https://github.com/gohugoio/hugo/releases/latest
|
||||
|
||||
### DragonFly BSD
|
||||
|
||||
[DragonFly BSD] includes Hugo in its package repository. To install the extended edition of Hugo:
|
||||
|
||||
```sh
|
||||
sudo pkg install gohugo
|
||||
```
|
||||
|
||||
[DragonFly BSD]: https://www.dragonflybsd.org/
|
||||
|
||||
### FreeBSD
|
||||
|
||||
[FreeBSD] includes Hugo in its package repository. To install the extended edition of Hugo:
|
||||
|
||||
```sh
|
||||
sudo pkg install gohugo
|
||||
```
|
||||
|
||||
[FreeBSD]: https://www.freebsd.org/
|
||||
|
||||
### NetBSD
|
||||
|
||||
[NetBSD] includes Hugo in its package repository. To install the extended edition of Hugo:
|
||||
|
||||
```sh
|
||||
sudo pkgin install go-hugo
|
||||
```
|
||||
|
||||
[NetBSD]: https://www.netbsd.org/
|
||||
|
||||
### OpenBSD
|
||||
|
||||
[OpenBSD] includes Hugo in its package repository. This will prompt you to select which edition of Hugo to install:
|
||||
|
||||
```sh
|
||||
doas pkg_add hugo
|
||||
```
|
||||
|
||||
[OpenBSD]: https://www.openbsd.org/
|
||||
|
||||
{{% include "installation/_common/04-build-from-source.md" %}}
|
||||
|
||||
## Comparison
|
||||
|
||||
||Prebuilt binaries|Repository packages|Build from source
|
||||
:--|:--:|:--:|:--:
|
||||
Easy to install?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
||||
Easy to upgrade?|:heavy_check_mark:|varies|:heavy_check_mark:
|
||||
Easy to downgrade?|:heavy_check_mark:|varies|:heavy_check_mark:
|
||||
Automatic updates?|:x:|varies|:x:
|
||||
Latest version available?|:heavy_check_mark:|varies|:heavy_check_mark:
|
||||
@@ -1,176 +0,0 @@
|
||||
---
|
||||
title: Linux
|
||||
description: Install Hugo on Linux.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 30
|
||||
weight: 30
|
||||
toc: true
|
||||
---
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
{{% include "installation/_common/02-prerequisites.md" %}}
|
||||
|
||||
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
|
||||
|
||||
## Package managers
|
||||
|
||||
### Snap
|
||||
|
||||
[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 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:
|
||||
|
||||
```sh
|
||||
sudo snap install hugo
|
||||
```
|
||||
|
||||
To enable or revoke access to removable media:
|
||||
|
||||
```sh
|
||||
sudo snap connect hugo:removable-media
|
||||
sudo snap disconnect hugo:removable-media
|
||||
```
|
||||
|
||||
To enable or revoke access to SSH keys:
|
||||
|
||||
```sh
|
||||
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" %}}
|
||||
|
||||
## 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 %}}
|
||||
|
||||
### Alpine Linux
|
||||
|
||||
To install the extended edition of Hugo on [Alpine Linux]:
|
||||
|
||||
```sh
|
||||
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:
|
||||
|
||||
```sh
|
||||
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:
|
||||
|
||||
```sh
|
||||
sudo apt install hugo
|
||||
```
|
||||
|
||||
You can also download Debian packages from the [latest release] page.
|
||||
|
||||
[Debian]: https://www.debian.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/
|
||||
|
||||
### Fedora
|
||||
|
||||
Derivatives of the [Fedora] distribution of Linux include [CentOS], [Red Hat Enterprise Linux], and others. To install the extended edition of Hugo:
|
||||
|
||||
```sh
|
||||
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. Follow the instructions below to install the extended edition of Hugo:
|
||||
|
||||
1. Specify the `extended` [USE] flag in /etc/portage/package.use/hugo:
|
||||
|
||||
```text
|
||||
www-apps/hugo extended
|
||||
```
|
||||
|
||||
2. Build using the Portage package manager:
|
||||
|
||||
```sh
|
||||
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
|
||||
|
||||
### openSUSE
|
||||
|
||||
Derivatives of the [openSUSE] distribution of Linux include [GeckoLinux], [Linux Karmada], and others. To install the extended edition of Hugo:
|
||||
|
||||
```sh
|
||||
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:
|
||||
|
||||
```sh
|
||||
sudo eopkg install hugo
|
||||
```
|
||||
|
||||
[Solus]: https://getsol.us/
|
||||
|
||||
{{% include "installation/_common/04-build-from-source.md" %}}
|
||||
|
||||
## Comparison
|
||||
|
||||
||Prebuilt binaries|Package managers|Repository packages|Build from source
|
||||
:--|:--:|:--:|:--:|:--:
|
||||
Easy to install?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
||||
Easy to upgrade?|:heavy_check_mark:|:heavy_check_mark:|varies|:heavy_check_mark:
|
||||
Easy to downgrade?|:heavy_check_mark:|:heavy_check_mark: [^1]|varies|:heavy_check_mark:
|
||||
Automatic updates?|:x:|varies [^2]|:x:|:x:
|
||||
Latest version available?|:heavy_check_mark:|:heavy_check_mark:|varies|:heavy_check_mark:
|
||||
|
||||
[^1]: Easy if a previous version is still installed.
|
||||
[^2]: Snap packages are automatically updated. Homebrew requires advanced configuration.
|
||||
@@ -1,46 +0,0 @@
|
||||
---
|
||||
title: macOS
|
||||
description: Install Hugo on macOS.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 20
|
||||
weight: 20
|
||||
toc: true
|
||||
---
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
{{% include "installation/_common/02-prerequisites.md" %}}
|
||||
|
||||
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
|
||||
|
||||
## Package managers
|
||||
|
||||
{{% include "installation/_common/homebrew.md" %}}
|
||||
|
||||
### MacPorts
|
||||
|
||||
[MacPorts] is a free and open-source package manager for macOS. To install the extended edition of Hugo:
|
||||
|
||||
```sh
|
||||
sudo port install hugo
|
||||
```
|
||||
|
||||
[MacPorts]: https://www.macports.org/
|
||||
|
||||
{{% include "installation/_common/04-build-from-source.md" %}}
|
||||
|
||||
## Comparison
|
||||
|
||||
||Prebuilt binaries|Package managers|Build from source
|
||||
:--|:--:|:--:|:--:
|
||||
Easy to install?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|
|
||||
Easy to upgrade?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
||||
Easy to downgrade?|:heavy_check_mark:|:heavy_check_mark: [^1]|:heavy_check_mark:
|
||||
Automatic updates?|:x:|:x: [^2]|:x:
|
||||
Latest version available?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
||||
|
||||
[^1]: Easy if a previous version is still installed.
|
||||
[^2]: Possible but requires advanced configuration.
|
||||
@@ -1,73 +0,0 @@
|
||||
---
|
||||
title: Windows
|
||||
description: Install Hugo on Windows.
|
||||
categories: [installation]
|
||||
keywords: []
|
||||
menu:
|
||||
docs:
|
||||
parent: installation
|
||||
weight: 40
|
||||
weight: 40
|
||||
toc: true
|
||||
---
|
||||
|
||||
{{% note %}}
|
||||
Hugo v0.121.1 and later require at least Windows 10 or Windows Server 2016.
|
||||
{{% /note %}}
|
||||
|
||||
{{% include "installation/_common/01-editions.md" %}}
|
||||
|
||||
{{% include "installation/_common/02-prerequisites.md" %}}
|
||||
|
||||
{{% include "installation/_common/03-prebuilt-binaries.md" %}}
|
||||
|
||||
## Package managers
|
||||
|
||||
### Chocolatey
|
||||
|
||||
[Chocolatey] is a free and open-source package manager for Windows. To install the extended edition of Hugo:
|
||||
|
||||
```sh
|
||||
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:
|
||||
|
||||
```sh
|
||||
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:
|
||||
|
||||
```sh
|
||||
winget install Hugo.Hugo.Extended
|
||||
```
|
||||
|
||||
[Winget]: https://learn.microsoft.com/en-us/windows/package-manager/
|
||||
|
||||
{{% 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 %}}
|
||||
|
||||
## Comparison
|
||||
|
||||
||Prebuilt binaries|Package managers|Build from source
|
||||
:--|:--:|:--:|:--:
|
||||
Easy to install?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:|
|
||||
Easy to upgrade?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
||||
Easy to downgrade?|:heavy_check_mark:|:heavy_check_mark: [^2]|:heavy_check_mark:
|
||||
Automatic updates?|:x:|:x: [^1]|:x:
|
||||
Latest version available?|:heavy_check_mark:|:heavy_check_mark:|:heavy_check_mark:
|
||||
|
||||
[^1]: Possible but requires advanced configuration.
|
||||
[^2]: Easy if a previous version is still installed.
|
||||
Reference in New Issue
Block a user