https://v0-122-0--gohugoio.netlify.app/functions/strings/Recent content in String functions on HugoHugo -- gohugo.ioenhttps://v0-122-0--gohugoio.netlify.app/functions/strings/chomp/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/chomp/If the argument is of type template.HTML, returns template.HTML, else returns a string. {{ chomp | "foo\n" }} → foo {{ chomp | "foo\n\n" }} → foo {{ chomp | "foo\r\n" }} → foo {{ chomp | "foo\r\n\r\n" }} → foohttps://v0-122-0--gohugoio.netlify.app/functions/strings/contains/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/contains/{{ strings.Contains "Hugo" "go" }} → true The check is case sensitive: {{ strings.Contains "Hugo" "Go" }} → falsehttps://v0-122-0--gohugoio.netlify.app/functions/strings/containsany/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/containsany/{{ strings.ContainsAny "Hugo" "gm" }} → true The check is case sensitive: {{ strings.ContainsAny "Hugo" "Gm" }} → falsehttps://v0-122-0--gohugoio.netlify.app/functions/strings/containsnonspace/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/containsnonspace/New in v0.111.0 {{ strings.ContainsNonSpace "\n" }} → false {{ strings.ContainsNonSpace " " }} → false {{ strings.ContainsNonSpace "\n abc" }} → true Common white space characters include: '\t', '\n', '\v', '\f', '\r', ' ' See the Unicode Character Database for a complete list.https://v0-122-0--gohugoio.netlify.app/functions/strings/count/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/count/If SUBSTR is an empty string, this function returns 1 plus the number of Unicode code points in STRING. {{ "aaabaab" | strings.Count "a" }} → 5 {{ "aaabaab" | strings.Count "aa" }} → 2 {{ "aaabaab" | strings.Count "aaa" }} → 1 {{ "aaabaab" | strings.Count "" }} → 8https://v0-122-0--gohugoio.netlify.app/functions/strings/countrunes/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/countrunes/In contrast with the strings.RuneCount function, which counts every rune in a string, strings.CountRunes excludes whitespace. {{ "Hello, 世界" | strings.CountRunes }} → 8https://v0-122-0--gohugoio.netlify.app/functions/strings/countwords/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/countwords/{{ "Hugo is a static site generator." | countwords }} → 6https://v0-122-0--gohugoio.netlify.app/functions/strings/findre/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/findre/By default, findRE finds all matches. You can limit the number of matches with an optional LIMIT argument. When specifying the regular expression, use a raw string literal (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. Go’s regular expression package implements the RE2 syntax. The RE2 syntax is a subset of that accepted by PCRE, roughly speaking, and with various caveats.https://v0-122-0--gohugoio.netlify.app/functions/strings/findresubmatch/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/findresubmatch/By default, findRESubmatch finds all matches. You can limit the number of matches with an optional LIMIT argument. A return value of nil indicates no match. When specifying the regular expression, use a raw string literal (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. Go’s regular expression package implements the RE2 syntax. The RE2 syntax is a subset of that accepted by PCRE, roughly speaking, and with various caveats.https://v0-122-0--gohugoio.netlify.app/functions/strings/firstupper/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/firstupper/{{ strings.FirstUpper "foo" }} → Foohttps://v0-122-0--gohugoio.netlify.app/functions/strings/hasprefix/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/hasprefix/{{ hasPrefix "Hugo" "Hu" }} → truehttps://v0-122-0--gohugoio.netlify.app/functions/strings/hassuffix/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/hassuffix/{{ hasSuffix "Hugo" "go" }} → truehttps://v0-122-0--gohugoio.netlify.app/functions/strings/repeat/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/repeat/{{ strings.Repeat 3 "yo" }} → yoyoyohttps://v0-122-0--gohugoio.netlify.app/functions/strings/replace/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/replace/{{ $s := "Batman and Robin" }} {{ replace $s "Robin" "Catwoman" }} → Batman and Catwoman Limit the number of replacements using the LIMIT argument: {{ replace "aabbaabb" "a" "z" 2 }} → zzbbaabbhttps://v0-122-0--gohugoio.netlify.app/functions/strings/replacere/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/replacere/When specifying the regular expression, use a raw string literal (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. Go’s regular expression package implements the RE2 syntax. The RE2 syntax is a subset of that accepted by PCRE, roughly speaking, and with various caveats. Note that the RE2 \C escape sequence is not supported. {{ $s := "a-b--c---d" }} {{ replaceRE `(-{2,})` "-" $s }} → a-b-c-d Limit the number of replacements using the LIMIT argument:https://v0-122-0--gohugoio.netlify.app/functions/strings/runecount/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/runecount/In contrast with the strings.CountRunes function, which excludes whitespace, strings.RuneCount counts every rune in a string. {{ "Hello, 世界" | strings.RuneCount }} → 9https://v0-122-0--gohugoio.netlify.app/functions/strings/slicestring/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/slicestring/For example, 1 and 4 creates a slice including elements 1 through 3. The end index can be omitted; it defaults to the string’s length. {{ slicestr "BatMan" 3 }}` → Man {{ slicestr "BatMan" 0 3 }}` → Bathttps://v0-122-0--gohugoio.netlify.app/functions/strings/split/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/split/Examples: {{ split "tag1,tag2,tag3" "," }} → ["tag1", "tag2", "tag3"] {{ split "abc" "" }} → ["a", "b", "c"] The strings.Split function essentially does the opposite of the collections.Delimit function. While split creates a slice from a string, delimit creates a string from a slice.https://v0-122-0--gohugoio.netlify.app/functions/strings/substr/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/substr/It normally takes two argument: start and length. It can also take one argument: start, i.e. length is omitted, in which case the substring starting from start until the end of the string will be returned. To extract characters from the end of the string, use a negative start number. If length is given and is negative, that number of characters will be omitted from the end of string. {{ substr "abcdef" 0 }} → abcdef {{ substr "abcdef" 1 }} → bcdef {{ substr "abcdef" 0 1 }} → a {{ substr "abcdef" 1 1 }} → b {{ substr "abcdef" 0 -1 }} → abcde {{ substr "abcdef" 1 -1 }} → bcde {{ substr "abcdef" -1 }} → f {{ substr "abcdef" -2 }} → ef {{ substr "abcdef" -1 1 }} → f {{ substr "abcdef" -2 1 }} → e {{ substr "abcdef" -3 -1 }} → de {{ substr "abcdef" -3 -2 }} → dhttps://v0-122-0--gohugoio.netlify.app/functions/strings/title/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/title/{{ title "table of contents (TOC)" }} → Table of Contents (TOC) By default, Hugo follows the capitalization rules published in the Associated Press Stylebook. Change your site configuration if you would prefer to: Follow the capitalization rules published in the Chicago Manual of Style Capitalize the first letter of every word Capitalize the first letter of the first word Disable the effects of the title function The last option is useful if your theme uses the title function, and you would prefer to manually capitalize strings as needed.https://v0-122-0--gohugoio.netlify.app/functions/strings/tolower/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/tolower/{{ lower "BatMan" }} → batmanhttps://v0-122-0--gohugoio.netlify.app/functions/strings/toupper/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/toupper/{{ upper "BatMan" }} → BATMANhttps://v0-122-0--gohugoio.netlify.app/functions/strings/trim/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/trim/{{ trim "++foo--" "+-" }} → foo To remove leading and trailing newline characters and carriage returns: {{ trim "\nfoo\n" "\n\r" }} → foo {{ trim "\n\nfoo\n\n" "\n\r" }} → foo {{ trim "\r\nfoo\r\n" "\n\r" }} → foo {{ trim "\r\n\r\nfoo\r\n\r\n" "\n\r" }} → foo The strings.Trim function is commonly used in shortcodes to remove leading and trailing newlines characters and carriage returns from the content within the opening and closing shortcode tags.https://v0-122-0--gohugoio.netlify.app/functions/strings/trimleft/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/trimleft/{{ strings.TrimLeft "a" "abba" }} → bba The strings.TrimLeft function converts the arguments to strings if possible: {{ strings.TrimLeft 21 12345 }} → 345 (string) {{ strings.TrimLeft "rt" true }} → uehttps://v0-122-0--gohugoio.netlify.app/functions/strings/trimprefix/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/trimprefix/{{ strings.TrimPrefix "a" "aabbaa" }} → abbaa {{ strings.TrimPrefix "aa" "aabbaa" }} → bbaa {{ strings.TrimPrefix "aaa" "aabbaa" }} → aabbaahttps://v0-122-0--gohugoio.netlify.app/functions/strings/trimright/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/trimright/{{ strings.TrimRight "a" "abba" }} → abb The strings.TrimRight function converts the arguments to strings if possible: {{ strings.TrimRight 54 12345 }} → 123 (string) {{ strings.TrimRight "eu" true }} → trhttps://v0-122-0--gohugoio.netlify.app/functions/strings/trimsuffix/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/trimsuffix/{{ strings.TrimSuffix "a" "aabbaa" }} → aabba {{ strings.TrimSuffix "aa" "aabbaa" }} → aabb {{ strings.TrimSuffix "aaa" "aabbaa" }} → aabbaahttps://v0-122-0--gohugoio.netlify.app/functions/strings/truncate/Mon, 01 Jan 0001 00:00:00 +0000https://v0-122-0--gohugoio.netlify.app/functions/strings/truncate/Since Go templates are HTML-aware, truncate will intelligently handle normal strings vs HTML strings: {{ "<em>Keep my HTML</em>" | safeHTML | truncate 10 }} → <em>Keep my …</em> If you have a raw string that contains HTML tags you want to remain treated as HTML, you will need to convert the string to HTML using the safeHTMLfunction before sending the value to truncate. Otherwise, the HTML tags will be escaped when passed through the truncate function.