Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688'

This commit is contained in:
Bjørn Erik Pedersen
2023-10-20 09:43:56 +02:00
298 changed files with 4568 additions and 1991 deletions

View File

@@ -0,0 +1,12 @@
## 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/

View File

@@ -0,0 +1,36 @@
## 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/

View File

@@ -0,0 +1,21 @@
## 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.
<!-- markdownlint-disable-next-line MD051 -->
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
[edition]: #editions
[Git]: https://git-scm.com/
[Go]: https://go.dev/
[Hugo Modules]: /hugo-modules/
[latest release]: https://github.com/gohugoio/hugo/releases/latest

View File

@@ -0,0 +1,23 @@
## Build from source
To build the extended edition of Hugo from source you must:
1. Install [Git]
1. Install [Go] version 1.19 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

View File

@@ -0,0 +1,9 @@
### Homebrew
[Homebrew] is a free and open source package manager for macOS and Linux. This will install the extended edition of Hugo:
```sh
brew install hugo
```
[Homebrew]: https://brew.sh/

View File

@@ -0,0 +1,3 @@
+++
headless = true
+++