Merge commit 'de0df119b504a91c9e1f442b07954f366ffb2932'

This commit is contained in:
Bjørn Erik Pedersen
2024-11-13 11:07:57 +01:00
89 changed files with 745 additions and 856 deletions

View File

@@ -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
@@ -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:
@@ -158,7 +172,7 @@ CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@latest
To build and install a specific release:
```sh
CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@v0.128.0
CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@v0.137.1
```
To build and install at the latest commit on the master branch:

View File

@@ -85,6 +85,24 @@ Yes → Hugo is fast.
"It's an adverb, Sam. It's a lazy tool of a weak mind." (Outbreak, 1995).
{{% /note %}}
#### Level 6 headings
Level 6 headings are styled as `dt` elements. This was implemented to support a [glossary] with linkable terms.
[glossary]: /getting-started/glossary/
#### Function and method descriptions
When adding a page to the [functions] or [methods] section, begin the description with the word "Returns". With functions and methods that return a boolean value, begin the description with the phrase "Reports whether".
For example:
- `Returns the URL aliases as defined in front matter.`
- `Reports whether the given page is in the given section.`
[functions]: /functions
[methods]: /methods
#### Miscellaneous
Other guidelines to consider:
@@ -97,12 +115,6 @@ Other guidelines to consider:
- When including code samples, use short snippets that demonstrate the concept.
- The Hugo user community is global; use [basic english](https://simple.wikipedia.org/wiki/Basic_English) when possible.
#### Level 6 headings
Level 6 headings are styled as `dt` elements. This was implemented to support a [glossary] with linkable terms.
[glossary]: /getting-started/glossary/
## Code examples
Indent code by two spaces. With examples of template code, include a space after opening action delimiters, and include a space before closing action delimiters.