Squashed 'docs/' changes from 327003421..39a7fac34

39a7fac34 Add .hugo_build.lock to .gitignore
920c716a4 fix a typo: to -> two (#1545)
6f0ba9593 Remove godocref from front matter (#1543)
8ec3d5948 remove link to wercker (#1544)
b56008719 Delete deployment-with-wercker.md (#1542)
e33d29b02 Fix broken links (#1538)
29e9d4c21 Sort commenting systems (#1541)
0b7ea60a7 Delete the news page "HTTP/2 Server Push in Hugo"
6e1515857 Fix quick-start.md (#1525)
62168ab35 Update comments.md (#1535)
d92191512 Small typo (#1539)
129c8834a Correct the PostCSS noMap default value (#1534)
6a5b29fcc Add example to index function (#1536)
e3dd8c507 Update output-formats.md
0c9321ca0 Remove reference to using LiveReload in production environment
4072d6776 Mod testing
09fabf7d6 Fix typo (#1524)
2fce813c8 Fix grammatical error in quick-start.md (#1523)
45230ab4a Hugo Mod testing
2dd4cd9e7 Update index.md
2c3ed62fd netlify: Bump to 0.88.1
648e2a007 Merge branch 'tempv0.88.1'
f216eade1 releaser: Add release notes to /docs for release of 0.88.1
8a7b64d4b Fix typographical errors in 0.88.0 release notes
a4bf86300 Release 0.88
738bb8f38 releaser: Add release notes to /docs for release of 0.88.0
8fcf2c55d highlight: Remove some pygments references
f2b173de2 HTTPS link
c88881c8e Adding link to nginx documentation
6b0a74fe0 Fix typos in docs (#1516)
498b8f0f1 Fix typos in time.Format (#1515)
28723fad6 Fix taxonomy and term examples (#1514)
3ffd00e12 Update front-matter.md
7cc1da82e Fix grammar in 0.86.1 release notes (#1510)
0009c51c3 Update docs helper
7e2f430f4 Update index.md
7857eae7e releaser: Add release notes to /docs for release of 0.87.0
1f08b684b releaser: Add release notes to /docs for release of 0.87.0
36a9e701c docs: Adjust config docs
0f588438e docs: Regen CLI docs
1b4682cd8 docs: Regen docs helper
bc8bbaae9 Merge commit 'bd77f6e1c99e04a476f0b1bb4e44569134e02399' into release-0.87.0
6f2480643 docs: Adjust time zone docs

git-subtree-dir: docs
git-subtree-split: 39a7fac343c289906db644c96079fdcc0298582f
This commit is contained in:
Bjørn Erik Pedersen 2021-10-31 13:51:51 +01:00
parent bd77f6e1c9
commit aa5ac36a3e
173 changed files with 749 additions and 778 deletions

3
.gitignore vendored
View file

@ -3,4 +3,5 @@
node_modules
nohup.out
.DS_Store
trace.out
trace.out
.hugo_build.lock

View file

@ -1,7 +1,6 @@
---
linktitle: ""
description: ""
godocref: ""
publishdate: ""
lastmod: ""
categories: []
@ -10,4 +9,4 @@ weight: 00
slug: ""
aliases: []
toc: false
---
---

View file

@ -1,7 +1,6 @@
---
linktitle: ""
description: ""
godocref: ""
publishdate: ""
lastmod: ""
categories: [functions]
@ -14,4 +13,4 @@ aliases: []
relatedfuncs: []
toc: false
deprecated: false
---
---

View file

@ -25,3 +25,7 @@ style = "trac"
lineNumbersInTable = true
noClasses = false
[tableOfContents]
endLevel = 2
ordered = false
startLevel = 2

View file

@ -69,6 +69,7 @@ hugo [flags]
### SEE ALSO
* [hugo check](/commands/hugo_check/) - Contains some verification checks
* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell
* [hugo config](/commands/hugo_config/) - Print the site configuration
* [hugo convert](/commands/hugo_convert/) - Convert your content to different formats
* [hugo deploy](/commands/hugo_deploy/) - Deploy your site to a Cloud provider.

View file

@ -0,0 +1,48 @@
---
title: "hugo completion"
slug: hugo_completion
url: /commands/hugo_completion/
---
## hugo completion
generate the autocompletion script for the specified shell
### Synopsis
Generate the autocompletion script for hugo for the specified shell.
See each sub-command's help for details on how to use the generated script.
### Options
```
-h, --help help for completion
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-e, --environment string build environment
--ignoreVendor ignores any _vendor directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
* [hugo completion bash](/commands/hugo_completion_bash/) - generate the autocompletion script for bash
* [hugo completion fish](/commands/hugo_completion_fish/) - generate the autocompletion script for fish
* [hugo completion powershell](/commands/hugo_completion_powershell/) - generate the autocompletion script for powershell
* [hugo completion zsh](/commands/hugo_completion_zsh/) - generate the autocompletion script for zsh

View file

@ -0,0 +1,62 @@
---
title: "hugo completion bash"
slug: hugo_completion_bash
url: /commands/hugo_completion_bash/
---
## hugo completion bash
generate the autocompletion script for bash
### Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
$ source <(hugo completion bash)
To load completions for every new session, execute once:
Linux:
$ hugo completion bash > /etc/bash_completion.d/hugo
MacOS:
$ hugo completion bash > /usr/local/etc/bash_completion.d/hugo
You will need to start a new shell for this setup to take effect.
```
hugo completion bash
```
### Options
```
-h, --help help for bash
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-e, --environment string build environment
--ignoreVendor ignores any _vendor directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell

View file

@ -0,0 +1,56 @@
---
title: "hugo completion fish"
slug: hugo_completion_fish
url: /commands/hugo_completion_fish/
---
## hugo completion fish
generate the autocompletion script for fish
### Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
$ hugo completion fish | source
To load completions for every new session, execute once:
$ hugo completion fish > ~/.config/fish/completions/hugo.fish
You will need to start a new shell for this setup to take effect.
```
hugo completion fish [flags]
```
### Options
```
-h, --help help for fish
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-e, --environment string build environment
--ignoreVendor ignores any _vendor directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell

View file

@ -0,0 +1,54 @@
---
title: "hugo completion powershell"
slug: hugo_completion_powershell
url: /commands/hugo_completion_powershell/
---
## hugo completion powershell
generate the autocompletion script for powershell
### Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
PS C:\> hugo completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
```
hugo completion powershell [flags]
```
### Options
```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-e, --environment string build environment
--ignoreVendor ignores any _vendor directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell

View file

@ -0,0 +1,61 @@
---
title: "hugo completion zsh"
slug: hugo_completion_zsh
url: /commands/hugo_completion_zsh/
---
## hugo completion zsh
generate the autocompletion script for zsh
### Synopsis
Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for every new session, execute once:
# Linux:
$ hugo completion zsh > "${fpath[1]}/_hugo"
# macOS:
$ hugo completion zsh > /usr/local/share/zsh/site-functions/_hugo
You will need to start a new shell for this setup to take effect.
```
hugo completion zsh [flags]
```
### Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--configDir string config dir (default "config")
--debug debug output
-e, --environment string build environment
--ignoreVendor ignores any _vendor directory
--ignoreVendorPaths string ignores any _vendor for module paths matching the given Glob pattern
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-s, --source string filesystem path to read files relative from
--themesDir string filesystem path to themes directory
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo completion](/commands/hugo_completion/) - generate the autocompletion script for the specified shell

View file

@ -47,29 +47,27 @@ Disqus has its own [internal template](https://gohugo.io/templates/internal/#dis
{{ template "_internal/disqus.html" . }}
```
## Comments Alternatives
## Alternatives
There are a few alternatives to commenting on static sites for those who do not want to use Disqus:
These are some alternatives to Disqus:
* [Cactus Comments](https://cactus.chat/docs/integrations/hugo/) (Open Source, Matrix appservice, Docker install)
* [Commento](https://commento.io/) (Open Source, available as a service, local install, or docker image)
* [Graph Comment](https://graphcomment.com/)
* [Hyvor Talk](https://talk.hyvor.com/) (Available as a service)
* [IntenseDebate](https://intensedebate.com/)
* [Isso](https://posativ.org/isso/) (Self-hosted, Python) ([tutorial][issotutorial])
* [Muut](https://muut.com/)
* [Remark42](https://remark42.com/) (Open source, Golang, Easy to run docker)
* [Staticman](https://staticman.net/)
* [Talkyard](https://www.talkyard.io/blog-comments) (Open source, & serverless hosting)
* [IntenseDebate](https://intensedebate.com/)
* [Graph Comment][]
* [Muut](https://muut.com/)
* [Isso](https://posativ.org/isso/) (Self-hosted, Python)
* [Tutorial on Implementing Isso with Hugo][issotutorial]
* [Utterances](https://utteranc.es/) (Open source, GitHub comments widget built on GitHub issues)
* [Remark](https://github.com/umputun/remark) (Open source, Golang, Easy to run docker)
* [Commento](https://commento.io/) (Open Source, available as a service, local install, or docker image)
* [Hyvor Talk](https://talk.hyvor.com/) (Available as a service)
[configuration]: /getting-started/configuration/
[disquspartial]: /templates/partials/#disqus
[disqussetup]: https://disqus.com/profile/signup/
[forum]: https://discourse.gohugo.io
[front matter]: /content-management/front-matter/
[Graph Comment]: https://graphcomment.com/
[kaijuissue]: https://github.com/spf13/kaiju/issues/new
[issotutorial]: https://stiobhart.net/2017-02-24-isso-comments/
[partials]: /templates/partials/

View file

@ -152,7 +152,6 @@ Markdown syntax is simple enough to learn in a single sitting. The following are
[mmark]: https://github.com/mmarkdown/mmark
[org]: https://orgmode.org/
[pandoc]: https://www.pandoc.org/
[Pygments]: https://pygments.org/
[rest]: https://docutils.sourceforge.io/rst.html
[sc]: /content-management/shortcodes/
[sct]: /templates/shortcode-templates/

View file

@ -185,7 +185,7 @@ path
: A [Glob](https://github.com/gobwas/glob) pattern matching the content path below /content. Expects Unix-styled slashes. Note that this is the virtual path, so it starts at the mount root. The matching support double-asterisks so you can match for patterns like `/blog/*/**` to match anything from the third level and down.
kind
: A Glob pattern matching the Page's Kind(s), e.g. "{home,section}".
: The Page's Kind, e.g. "section".
lang
: A Glob pattern matching the Page's language, e.g. "{en,sv}".

View file

@ -2,7 +2,6 @@
title: Shortcodes
linktitle:
description: Shortcodes are simple snippets inside your content files calling built-in or custom templates.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2019-11-07
@ -435,7 +434,6 @@ To learn more about creating custom shortcodes, see the [shortcode template docu
[Instagram]: https://www.instagram.com/
[pagevariables]: /variables/page/
[partials]: /templates/partials/
[Pygments]: https://pygments.org/
[quickstart]: /getting-started/quick-start/
[sctemps]: /templates/shortcode-templates/
[scvars]: /variables/shortcodes/

View file

@ -24,7 +24,7 @@ See [Configure Highlight](/getting-started/configuration-markup#highlight).
## Generate Syntax Highlighter CSS
If you run with `pygmentsUseClasses=true` in your site config, you need a style sheet.
If you run with `markup.highlight.noClasses=false` in your site config, you need a style sheet.
You can generate one with Hugo:

View file

@ -336,7 +336,7 @@ pick 33c8973 Begin workflow
pick 3502f2e Refactoring and typo fixes
```
In the case above we should merge the last to commits in the commit of this tutorial (`Add "How to contribute to Hugo" tutorial`). You can "squash" commits, i.e. merge two or more commits into a single one.
In the case above we should merge the last two commits in the commit of this tutorial (`Add "How to contribute to Hugo" tutorial`). You can "squash" commits, i.e. merge two or more commits into a single one.
All operations are written before the commit message. Replace "pick" with an operation. In this case `squash` or `s` for short:

View file

@ -1,7 +1,6 @@
---
title: .GetPage
description: "Gets a `Page` of a given `path`."
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: .RenderString
description: "Renders markup to HTML."
godocref:
date: 2019-12-18
categories: [functions]
menu:

View file

@ -2,7 +2,6 @@
title: Functions Quick Reference
linktitle: Functions Quick Reference
description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: absLangURL
description: Adds the absolute URL with correct language prefix according to site configuration for multilingual.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: absURL
description: Creates an absolute URL based on the configured baseURL.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: .AddDate
description: Returns the time corresponding to adding the given number of years, months, and days passed to the function.
godocref: https://golang.org/pkg/time/#Time.AddDate
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: after
description: "`after` slices an array to only the items after the <em>N</em>th item."
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: apply
description: Given a map, array, or slice, `apply` returns a new slice with a function applied over it.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: base64
description: "`base64Encode` and `base64Decode` let you easily decode content with a base64 encoding and vice versa through pipes."
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,7 @@
---
title: chomp
toc: true
description: Removes any trailing newline characters.
godocref: Removes any trailing newline characters.
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: countrunes
description: Determines the number of runes in a string excluding any whitespace.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: countwords
description: Counts the number of words in a string.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: time.Format
description: Converts a date/time to a localized string.
godocref: https://golang.org/pkg/time/
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -23,7 +22,7 @@ deprecated: false
{{ time.Format "Monday, Jan 2, 2006" "2015-01-21" }} → "Wednesday, Jan 21, 2015"
```
Note that since Hugo 0.87.0, `time.Format` will return a localized string for the currrent language. {{< new-in "0.87.0" >}}
Note that since Hugo 0.87.0, `time.Format` will return a localized string for the current language. {{< new-in "0.87.0" >}}
The `LAYOUT` string can be either:
@ -37,7 +36,7 @@ See the [`time` function](/functions/time/) to convert a timestamp string to a G
{{< new-in "0.87.0" >}}
Go's date layout strings can be hard to reason about, especially with multiple languages. Since Hugo 0.87.0 you can alternatively use some predefined layout idenfifiers that will output localized dates or times:
Go's date layout strings can be hard to reason about, especially with multiple languages. Since Hugo 0.87.0 you can alternatively use some predefined layout identifiers that will output localized dates or times:
```go-html-template
{{ .Date | time.Format ":date_long" }}

View file

@ -2,7 +2,6 @@
title: default
description: Allows setting a default value that can be returned if a first value is not set.
qref: "Returns a default value if a value is not set when checked."
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: delimit
description: Loops through any array, slice, or map and returns a string of all the values separated by a delimiter.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: dict
description: Creates a dictionary from a list of key and value pairs.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-26

View file

@ -1,7 +1,6 @@
---
title: echoParam
description: Prints a parameter if it is set.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: emojify
description: Runs a string through the Emoji emoticons processor.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: eq
linktitle: eq
description: Returns the boolean truth of arg1 == arg2.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -3,7 +3,6 @@ title: "fileExists"
linktitle: "fileExists"
date: 2017-08-31T22:38:22+02:00
description: Checks whether a file exists under the given path.
godocref:
publishdate: 2017-08-31T22:38:22+02:00
lastmod: 2017-08-31T22:38:22+02:00
categories: [functions]
@ -26,4 +25,4 @@ aliases: []
{{- end }}
```
In the example above, a banner from the `static` folder should be shown if the given path points to an existing file.
In the example above, a banner from the `static` folder should be shown if the given path points to an existing file.

View file

@ -1,7 +1,6 @@
---
title: findRE
description: Returns a list of strings that match the regular expression.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: first
linktitle: first
description: "Slices an array to only the first _N_ elements."
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: float
linktitle: float
description: Creates a `float` from the argument passed into the function.
godocref:
date: 2017-09-28
publishdate: 2017-09-28
lastmod: 2017-09-28

View file

@ -1,7 +1,6 @@
---
title: .Format
description: Formats built-in Hugo dates---`.Date`, `.PublishDate`, and `.Lastmod`---according to Go's layout string.
godocref: https://golang.org/pkg/time/#example_Time_Format
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: ge
linktitle: ge
description: Returns the boolean truth of arg1 >= arg2.
godocref:
date: 2017-07-26
publishdate: 2017-07-26
lastmod: 2017-07-26

View file

@ -1,7 +1,6 @@
---
title: .Get
description: Accesses positional and ordered parameters in shortcode declaration.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -29,7 +28,3 @@ When accessing a named parameter that does not exist, `.Get` returns an empty st
```
[sc]: /templates/shortcode-templates/

View file

@ -1,7 +1,6 @@
---
title: getenv
description: Returns the value of an environment variable.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: gt
linktitle: gt
description: Returns the boolean truth of arg1 > arg2.
godocref:
date: 2017-07-26
publishdate: 2017-07-26
lastmod: 2017-07-26

View file

@ -2,7 +2,6 @@
title: hasprefix
linktitle: hasPrefix
description: Tests whether a string begins with prefix.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: .HasChildren
description:
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: .HasMenuCurrent
description:
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: highlight
linktitle: highlight
description: Takes a string of code and language declaration and uses Chroma to return syntax-highlighted HTML.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -22,5 +21,3 @@ deprecated: false
[highlight]: /content-management/shortcodes/#highlight
[installpygments]: /getting-started/installing/#installing-pygments-optional
[syntax]: /content-management/syntax-highlighting/

View file

@ -2,7 +2,6 @@
title: hmac
linktitle: hmac
description: Compute the cryptographic checksum of a message.
godocref:
date: 2020-05-29
publishdate: 2020-05-29
lastmod: 2020-05-29

View file

@ -2,7 +2,6 @@
title: htmlEscape
linktitle:
description: Returns the given string with the reserved HTML codes escaped.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: htmlUnescape
linktitle: htmlUnescape
description: Returns the given string with HTML escape codes un-escaped.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: hugo
linktitle: hugo
description: The `hugo` function provides easy access to Hugo-related data.
godocref:
date: 2019-01-31
publishdate: 2019-01-31
lastmod: 2019-01-31
@ -50,4 +49,3 @@ hugo.IsProduction
{{% note "Use the Hugo Generator Tag" %}}
We highly recommend using `hugo.Generator` in your website's `<head>`. `hugo.Generator` is included by default in all themes hosted on [themes.gohugo.io](https://themes.gohugo.io). The generator tag allows the Hugo team to track the usage and popularity of Hugo.
{{% /note %}}

View file

@ -2,7 +2,6 @@
title: humanize
linktitle:
description: Returns the humanized version of an argument with the first letter capitalized.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: i18n
linktitle: i18n
description: Translates a piece of content based on your i18n configuration files.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: Image Functions
description: The images namespace provides a list of filters and other image related functions.
godocref:
date: 2017-02-01
categories: [functions]
aliases: [/functions/imageconfig/]

View file

@ -2,7 +2,6 @@
title: in
linktitle:
description: Checks if an element is in an array or slice--or a substring in a string---and returns a boolean.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: index
linktitle: index
description: Looks up the index(es) or key(s) of the data structure passed into it.
godocref: https://golang.org/pkg/text/template/#hdr-Functions
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -38,6 +37,14 @@ The function takes multiple indices as arguments, and this can be used to get ne
{{ index $map "c" "e" }} => 20
```
You may write multiple indices as a slice:
```go-text-template
{{ $map := dict "a" 100 "b" 200 "c" (dict "d" 10 "e" 20) }}
{{ $slice := slice "c" "e" }}
{{ index $map $slice }} => 20
```
## Example: Load Data from a Path Based on Front Matter Params
Assume you want to add a `location = ""` field to your front matter for every article written in `content/vacations/`. You want to use this field to populate information about the location at the bottom of the article in your `single.html` template. You also have a directory in `data/locations/` that looks like the following:

View file

@ -2,7 +2,6 @@
title: int
linktitle: int
description: Creates an `int` from the argument passed into the function.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: intersect
linktitle: intersect
description: Returns the common elements of two arrays or slices, in the same order as the first array.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: .IsMenuCurrent
description:
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: isset
linktitle: isset
description: Returns true if the parameter is set.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -29,4 +28,3 @@ Takes either a slice, array, or channel and an index or a map and a key as input
All site-level configuration keys are stored as lower case. Therefore, a `myParam` key-value set in your [site configuration file](/getting-started/configuration/) needs to be accessed with `{{if isset .Site.Params "myparam"}}` and *not* with `{{if isset .Site.Params "myParam"}}`. Note that you can still access the same config key with `.Site.Params.myParam` *or* `.Site.Params.myparam`, for example, when using [`with`](/functions/with).
This restriction also applies when accessing page-level front matter keys from within [shortcodes](/content-management/shortcodes/).
{{% /warning %}}

View file

@ -2,7 +2,6 @@
title: jsonify
linktitle: jsonify
description: Encodes a given object to JSON.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2020-04-13

View file

@ -1,7 +1,6 @@
---
title: lang.Merge
description: "Merge missing translations from other languages."
godocref: ""
date: 2018-03-16
categories: [functions]
keywords: [multilingual]

View file

@ -8,23 +8,9 @@ keywords: [numbers]
menu:
docs:
parent: "functions"
toc: false
signature: ["lang.NumFmt PRECISION NUMBER [OPTIONS [DELIMITER]]"]
aliases: ['/functions/numfmt/']
type: 'template-func'
---
The default options value is `- . ,`. The default delimiter within the options
value is a space. If you need to use a space as one of the options, set a
custom delimiter.s
Numbers greater than or equal to 5 are rounded up. For example, if precision is set to `0`, `1.5` becomes `2`, and `1.4` becomes `1`.
```
{{ lang.NumFmt 2 12345.6789 }} → 12,345.68
{{ lang.NumFmt 2 12345.6789 "- , ." }} → 12.345,68
{{ lang.NumFmt 0 -12345.6789 "- . ," }} → -12,346
{{ lang.NumFmt 6 -12345.6789 "- ." }} → -12345.678900
{{ lang.NumFmt 6 -12345.6789 "-|.| " "|" }} → -1 2345.678900
{{ -98765.4321 | lang.NumFmt 2 }} → -98,765.43
```

View file

@ -2,7 +2,6 @@
title: last
linktitle: last
description: "slices an array to only the last <em>N</em>th elements."
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: le
linktitle: le
description: Returns the boolean truth of arg1 <= arg2.
godocref:
date: 2017-07-26
publishdate: 2017-07-26
lastmod: 2017-07-26

View file

@ -2,7 +2,6 @@
title: len
linktitle: len
description: Returns the length of a variable according to its type.
godocref: https://golang.org/pkg/builtin/#len
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-04-18

View file

@ -2,7 +2,6 @@
title: lower
linktitle: lower
description: Converts all characters in the provided string to lowercase.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: lt
linktitle: lt
description: Returns the boolean truth of arg1 < arg2.
godocref:
date: 2017-07-26
publishdate: 2017-07-26
lastmod: 2017-07-26

View file

@ -2,7 +2,6 @@
title: markdownify
linktitle: markdownify
description: Runs the provided string through the Markdown processor.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -27,4 +26,4 @@ aliases: []
*Note*: if you need [Render Hooks][], which `markdownify` doesn't currently
support, use [.RenderString](/functions/renderstring/) instead.
[Render Hooks]: /getting-started/configuration-markup/#markdown-render-hooks
[Render Hooks]: /getting-started/configuration-markup/#markdown-render-hooks

View file

@ -1,7 +1,6 @@
---
title: Math
description: Hugo provides mathematical operators in templates.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2020-02-23

View file

@ -2,7 +2,6 @@
title: md5
linktitle: md5
description: hashes the given input and returns its MD5 checksum.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: ne
linktitle: ne
description: Returns the boolean truth of arg1 != arg2.
godocref:
date: 2017-07-26
publishdate: 2017-07-26
lastmod: 2017-07-26

View file

@ -2,7 +2,6 @@
title: now
linktitle: now
description: Returns the current local time
godocref: https://godoc.org/time#Time
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-04-30

View file

@ -1,7 +1,6 @@
---
title: os.Stat
description: Gets a file information of a given path.
godocref:
date: 2018-08-07
publishdate: 2018-08-07
lastmod: 2018-08-07

View file

@ -1,7 +1,6 @@
---
title: .Param
description: Calls page or site variables into your template.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-04-30

View file

@ -2,7 +2,6 @@
title: partialCached
linktitle: partialCached
description: Allows for caching of partials that do not need to be re-rendered on every invocation.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: path.Base
description: Base returns the last element of a path.
godocref:
date: 2018-11-28
publishdate: 2018-11-28
lastmod: 2018-11-28

View file

@ -1,7 +1,6 @@
---
title: path.Dir
description: Dir returns all but the last element of a path.
godocref:
date: 2018-11-28
publishdate: 2018-11-28
lastmod: 2018-11-28

View file

@ -1,7 +1,6 @@
---
title: path.Ext
description: Ext returns the file name extension of a path.
godocref:
date: 2018-11-28
publishdate: 2018-11-28
lastmod: 2018-11-28

View file

@ -1,7 +1,6 @@
---
title: path.Join
description: Join path elements into a single path.
godocref:
date: 2018-11-28
publishdate: 2018-11-28
lastmod: 2018-11-28

View file

@ -1,7 +1,6 @@
---
title: path.Split
description: Split path immediately following the final slash.
godocref:
date: 2018-11-28
publishdate: 2018-11-28
lastmod: 2018-11-28

View file

@ -2,7 +2,6 @@
title: plainify
linktitle: plainify
description: Strips any HTML and returns the plain text version of the provided string.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-04-30

View file

@ -2,7 +2,6 @@
title: pluralize
linktitle: pluralize
description: Pluralizes the given word according to a set of common English pluralization rules
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -22,4 +21,3 @@ aliases: []
```
{{ "cat" | pluralize }} → "cats"
```

View file

@ -2,7 +2,6 @@
title: print
linktitle: print
description: Prints the default representation of the given arguments using the standard `fmt.Print` function.
godocref: https://golang.org/pkg/fmt/
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: printf
linktitle: printf
description: Formats a string using the standard `fmt.Sprintf` function.
godocref: https://golang.org/pkg/fmt/
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: println
linktitle: println
description: Prints the default representation of the given argument using the standard `fmt.Print` function and enforces a linebreak.
godocref: https://golang.org/pkg/fmt/
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -10,7 +10,6 @@ menu:
docs:
parent: "functions"
keywords: [urls]
godocref:
signature: ["querify KEY VALUE [KEY VALUE]...", "querify COLLECTION"]
hugoversion:
deprecated: false

View file

@ -2,7 +2,6 @@
title: range
linktitle:
description: Iterates over a map, array, or slice.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: readDir
description: Gets a directory listing from a directory relative to the current working directory.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01
@ -27,4 +26,3 @@ If your current project working directory has a single file named `README.txt`:
For more information on using `readDir` and `readFile` in your templates, see [Local File Templates][local].
[local]: /templates/files/

View file

@ -1,7 +1,6 @@
---
title: readFile
description: Reads a file from disk relative to the current project working directory and returns a string.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-04-30

View file

@ -2,7 +2,6 @@
title: ref
linktitle: ref
description: Returns the absolute permalink to a page.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2020-09-05

View file

@ -1,7 +1,6 @@
---
title: reflect.IsMap
description: Reports if a value is a map.
godocref:
date: 2018-11-28
publishdate: 2018-11-28
lastmod: 2018-11-28

View file

@ -1,7 +1,6 @@
---
title: reflect.IsSlice
description: Reports if a value is a slice.
godocref:
date: 2018-11-28
publishdate: 2018-11-28
lastmod: 2018-11-28

View file

@ -1,7 +1,6 @@
---
title: relLangURL
description: Adds the relative URL with correct language prefix according to site configuration for multilingual.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -2,7 +2,6 @@
title: relref
linktitle: relref
description: Returns the relative permalink to a page.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2020-09-05

View file

@ -1,7 +1,6 @@
---
title: relURL
description: Creates a baseURL-relative URL.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: .Render
description: Takes a view to apply when rendering content.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2017-02-01

View file

@ -1,7 +1,6 @@
---
title: replace
description: Replaces all occurrences of the search string with the replacement string.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2020-09-07
@ -27,4 +26,3 @@ The number of replacements can be limited with an optional `LIMIT` parameter.
{{ replace "aabbaabb" "a" "z" 2 }} → "zzbbaabb"
```

View file

@ -1,7 +1,6 @@
---
title: replaceRE
description: Replaces all occurrences of a regular expression with the replacement pattern.
godocref:
date: 2017-02-01
publishdate: 2017-02-01
lastmod: 2020-09-07

Some files were not shown because too many files have changed in this diff Show more