String

Hugo essentially packed Go's strings package under the keyword strings. Therefore, the string manipulations are more or less similar to Go's string manipulations (They are NOT the same). However, for the benefit of the non-Go development viewers, I will list some useful functions here.

From time to time, you need to visit: https://godoc.org/github.com/gohugoio/hugo/tpl/strings to checkout any more available functions to use.

Check Prefix and Suffix Pattern

Useful for URL constructions or pattern recognition. To check whether a string has a prefix or suffix pattern, use the strings.HasPrefix and strings.HasSuffix functions:

{{- $stringValue := "Hugo" -}}

{{ strings.HasPrefix $stringValue "H" }}   # -> true

{{ strings.HasSuffix $stringValue "go" }} # --> true

{{ strings.HasPrefix $stringValue "go" }} # --> false

{{ strings.HasSuffix $stringValue "H" }}   # -> false

Trim Prefix and Suffix by Pattern

In the case where you want to trim the prefix and suffix, the same strings.TrimPrefix and strings.TrimSuffix are the one good for the job. If the pattern is not found, the string remains as it is.

{{- $stringValue := "LetsGoForABeer" -}}

{{ strings.TrimPrefix $stringValue "Lets" }}   # -> GoForABeer

{{ strings.TrimSuffix $stringValue "Beer" }} # --> LetsGoForA

{{ strings.TrimPrefix $stringValue "Beer" }} # --> LetsGoForABeer

{{ strings.TrimSuffix $stringValue "Lets" }}   # -> LetsGoForABeer

Typography Conversion

These are conversion from Title, UPPERCASE, First upper, and lowercase.

To Title Case

Convert the string to Title Case.

{{- $stringValue := "lets go for a beer" -}}

{{ strings.Title $stringValue }}   # -> Lets Go For A Beer

To UPPERCASE

Convert the string to UPPERCASE.

{{- $stringValue := "lets go for a beer" -}}

{{ strings.ToUpper $stringValue }}   # -> LETS GO FOR A BEER

To lowercase

Covert the string to lowercase.

{{- $stringValue := "LETS GO FOR A BEER" -}}

{{ strings.ToLower $stringValue }}   # -> lets go for a beer

To First Character Uppercase

Covert only the first character to Uppercase.

{{- $stringValue := "lets go for a beer" -}}

{{ strings.FirstUpper $stringValue }}   # -> Lets go for a beer

Search and Replace

Search Sub-String

To search sub-string.

{{- $stringValue := "lets go for a beer" -}}

{{ strings.Contains $stringValue "beer" }}   # -> true

For lesser restriction,

{{- $stringValue := "lets go for a beer" -}}

{{ strings.ContainsAny $stringValue "beer" }}   # -> true

Replace All

Replace all occurrence with given string.

{{- $stringValue := "lets go for a beer and another beer" -}}

{{ strings.Replace $stringValue "whiskey" }}   # -> lets go for a whiskey and another whiskey

Slicing and Splitting

Slice a String

{{- $stringValue := "lets go for a beer" -}}

{{- $start := 2 -}}

{{- $end := 5 -}}

{{ strings.SliceString $stringValue $start }}     # -> "ts go for a beer"

{{ strings.SliceString $stringValue $start $end }}   # -> "ts g"

Split a String

{{- $stringValue := "lets go for a beer" -}}

{{- $delimiter := " " -}}

{{ strings.Split $stringValue $delimiter }}   # -> ["lets", "go", "for", "a", "beer"]

Count and Analyze

Count Total Runes

{{- $stringValue := "lets go for a beer" -}}

{{ strings.CountRunes $stringValue }}          # -> 14 (w/o whitespace)

{{ strings.RunesCount $stringValue }}          # -> 18 (total runes)

Count Total Words

{{- $stringValue := "lets go for a beer" -}}

{{ strings.CountWords $stringValue }}          # -> 5

That's all about string manipulations.

Page updated

Google Sites

Report abuse