Skip to content

Commit

Permalink
Describe and refer to the extended/deploy edition
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring authored and bep committed Nov 4, 2024
1 parent 3d33023 commit 3744f3b
Show file tree
Hide file tree
Showing 14 changed files with 76 additions and 29 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,10 @@ A fast and flexible static site generator built with love by [bep], [spf13], and
[![Netlify Status](https://api.netlify.com/api/v1/badges/e0dbbfc7-34f1-4393-a679-c16e80162705/deploy-status)](https://app.netlify.com/sites/gohugoio/deploys)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://gohugo.io/contribute/documentation/)

This is the repository for the [Hugo](https://github.com/gohugoio/hugo) documentation site.
This is the repository for the [Hugo](https://github.com/gohugoio/hugo) documentation site.

Please see the [contributing] section for guidelines, examples, and process.



[bep]: https://github.com/bep
[spf13]: https://github.com/spf13
[friends]: https://github.com/gohugoio/hugo/graphs/contributors
Expand Down
18 changes: 16 additions & 2 deletions content/en/contribute/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ For a complete guide to contributing to Hugo, see the [Contribution Guide].

## Prerequisites

To build the extended edition of Hugo from source you must:
To build the extended or extended/deploy edition from source you must:

1. Install [Git]
1. Install [Go] version 1.23.0 or later
Expand Down Expand Up @@ -97,12 +97,26 @@ Step 4
: Make changes.

Step 5
: Compile and install:
: Compile and install.

To compile and install the standard edition:

```text
go install
```

To compile and install the extended edition:

```text
CGO_ENABLED=1 go install -tags extended
```

To compile and install the extended/deploy edition:

```text
CGO_ENABLED=1 go install -tags extended,withdeploy
```

Step 6
: Test your changes:

Expand Down
4 changes: 2 additions & 2 deletions content/en/functions/css/Sass.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ toc: true
{{ end }}
```

Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended edition, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language.
Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended and extended/deploy editions, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language.

Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both.

Expand All @@ -42,7 +42,7 @@ Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both.
## Options

transpiler
: (`string`) The transpiler to use, either `libsass` (default) or `dartsass`. Hugo's extended edition includes the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass) below.
: (`string`) The transpiler to use, either `libsass` (default) or `dartsass`. Hugo's extended and extended/deploy editions include the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass) below.

targetPath
: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`.
Expand Down
4 changes: 2 additions & 2 deletions content/en/functions/resources/ToCSS.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Use [css.Sass] instead.
{{ end }}
```

Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended edition, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language.
Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended and extended/deploy editions, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language.

Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both.

Expand All @@ -46,7 +46,7 @@ Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both.
## Options

transpiler
: (`string`) The transpiler to use, either `libsass` (default) or `dartsass`. Hugo's extended edition includes the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass) below.
: (`string`) The transpiler to use, either `libsass` (default) or `dartsass`. Hugo's extended and extended/deploy editions include the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass) below.

targetPath
: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`.
Expand Down
2 changes: 1 addition & 1 deletion content/en/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ In this tutorial you will:

Before you begin this tutorial you must:

1. [Install Hugo] (extended edition, {{% param "minVersion" %}} or later)
1. [Install Hugo] (extended or extended/deploy edition, {{% param "minVersion" %}} or later)
1. [Install Git]

You must also be comfortable working from the command line.
Expand Down
9 changes: 7 additions & 2 deletions content/en/hosting-and-deployment/hugo-deploy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Hugo Deploy
description: Upload your site to GCS, S3, or Azure
description: Deploy your site directly to a Google Cloud Storage bucket, an AWS S3 bucket, or an Azure Storage container.
categories: [hosting and deployment]
keywords: [deployment,s3,gcs,azure]
menu:
Expand All @@ -11,8 +11,13 @@ weight: 20
toc: true
---

You can use the "hugo deploy" command to upload your site directly to a Google Cloud Storage (GCS) bucket, an AWS S3 bucket, and/or an Azure Storage container.
Use the `hugo deploy` command to deploy your site directly to a Google Cloud Storage bucket, an AWS S3 bucket, or an Azure Storage container

{{% note %}}
This feature requires the Hugo extended/deploy edition. See the [installation] section for details.

[installation]: /installation/
{{% /note %}}

## Assumptions

Expand Down
4 changes: 2 additions & 2 deletions content/en/hugo-pipes/transpile-sass-to-css.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ aliases: [/hugo-pipes/transform-to-css/]

## Usage

Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended edition, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language.
Transpile Sass to CSS using the LibSass transpiler included in Hugo's extended and extended/deploy editions, or [install Dart Sass](#dart-sass) to use the latest features of the Sass language.

```go-html-template
{{ $opts := dict "transpiler" "libsass" "targetPath" "css/style.css" }}
Expand All @@ -37,7 +37,7 @@ Sass has two forms of syntax: [SCSS] and [indented]. Hugo supports both.
## Options

transpiler
: (`string`) The transpiler to use, either `libsass` (default) or `dartsass`. Hugo's extended edition includes the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass) below.
: (`string`) The transpiler to use, either `libsass` (default) or `dartsass`. Hugo's extended and extended/deploy editions include the LibSass transpiler. To use the Dart Sass transpiler, see the [installation instructions](#dart-sass) below.

targetPath
: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`.
Expand Down
14 changes: 7 additions & 7 deletions content/en/installation/_common/01-editions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
# Do not remove front matter.
---

## Editions
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.

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.
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]: /hugo-pipes/transpile-sass-to-css/#dart-sass
[processing images]: /content-management/image-processing/
[transpile sass to css]: /hugo-pipes/transpile-sass-to-css/
[details]: /hosting-and-deployment/hugo-deploy/
17 changes: 14 additions & 3 deletions content/en/installation/_common/04-build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Build from source

To build the extended edition of Hugo from source you must:
To build the extended or extended/deploy edition from source you must:

1. Install [Git]
1. Install [Go] version 1.20 or later
Expand All @@ -13,11 +13,22 @@ To build the extended edition of Hugo from source you must:

> 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:
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
hugo version
```

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/
Expand Down
5 changes: 5 additions & 0 deletions content/en/installation/bsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,13 @@ menu:
weight: 50
toc: true
---

## Editions

{{% include "installation/_common/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 "installation/_common/03-prebuilt-binaries.md" %}}
Expand Down
5 changes: 5 additions & 0 deletions content/en/installation/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,13 @@ menu:
weight: 30
toc: true
---

## Editions

{{% include "installation/_common/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 "installation/_common/03-prebuilt-binaries.md" %}}
Expand Down
5 changes: 5 additions & 0 deletions content/en/installation/macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,13 @@ menu:
weight: 20
toc: true
---

## Editions

{{% include "installation/_common/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 "installation/_common/03-prebuilt-binaries.md" %}}
Expand Down
4 changes: 4 additions & 0 deletions content/en/installation/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,12 @@ toc: true
Hugo v0.121.1 and later require at least Windows 10 or Windows Server 2016.
{{% /note %}}

## Editions

{{% include "installation/_common/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 "installation/_common/03-prebuilt-binaries.md" %}}
Expand Down
10 changes: 5 additions & 5 deletions content/en/troubleshooting/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@ Hugo’s [forum] is an active community of users and developers who answer quest

These are just a few of the questions most frequently asked by new users.

###### An error message indicates that a feature is not available. Why?
###### An error message indicates that a feature is not available. Why? {#feature-not-available}

Hugo is available in two editions: standard and extended. With the extended edition you can (a) encode to the WebP format when processing images, and (b) transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler.
{{% include "installation/_common/01-editions.md" %}}

When you attempt to perform either of the operations above with the standard edition, Hugo throws this error:
When you attempt to use a feature that is not available in the edition that you installed, Hugo throws this error:

```go-html-template
Error: this feature is not available in your current Hugo version
this feature is not available in this edition of Hugo
```

To resolve, uninstall the standard edition, then install the extended edition. See the [installation] section for details.
To resolve, install a different edition based on the feature table above. See the [installation] section for details.

###### Why do I see "Page Not Found" when visiting the home page?

Expand Down

0 comments on commit 3744f3b

Please sign in to comment.