urls.URLize
Returns the given string, sanitized for usage in a URL.
- Syntax
- urls.URLize INPUT
- Returns
- string
- Alias
- urlize
Usage
The urls.URLize function returns the given string, sanitized for usage in a URL. The function replaces each sequence of whitespace with a hyphen, removes leading and trailing whitespace, and removes most punctuation. It then converts the result to lowercase and applies percent-encoding to non-ASCII characters.
To remove accents before encoding, set removePathAccents to true in your project configuration. To preserve the original case, set disablePathToLower to true.
To sanitize a string for usage in an HTML id attribute, use the urls.Anchorize function instead.
Examples
{{ urls.URLize "Hello, World!" }} → hello-world
{{ urls.URLize "a b c" }} → a-b-c
{{ urls.URLize "main.go" }} → main.go
{{ urls.URLize "Les Misérables" }} → les-mis%C3%A9rablesStrings containing # or % characters:
{{ urls.URLize "C#" }} → c
{{ urls.URLize "C# 101" }} → c#-101
{{ urls.URLize "50%" }} → 50With disablePathToLower set to true:
{{ urls.URLize "Hello, World!" }} → Hello-World
{{ urls.URLize "Les Misérables" }} → Les-Mis%C3%A9rablesWith removePathAccents set to true:
{{ urls.URLize "Les Misérables" }} → les-miserablesComparing the result with urls.Anchorize:
{{ $s := "A B C" }}
{{ urls.Anchorize $s }} → a-b-c
{{ urls.URLize $s }} → a-b-c
{{ $s := "a b c" }}
{{ urls.Anchorize $s }} → a-b---c
{{ urls.URLize $s }} → a-b-c
{{ $s := "< a, b, & c >" }}
{{ urls.Anchorize $s }} → -a-b--c-
{{ urls.URLize $s }} → a-b-c
{{ $s := "main.go" }}
{{ urls.Anchorize $s }} → maingo
{{ urls.URLize $s }} → main.go
{{ $s := "Hugö" }}
{{ urls.Anchorize $s }} → hugö
{{ urls.URLize $s }} → hug%C3%B6Last updated:
November 15, 2026
:
content: Apply style guide to urls functions (7d84f1890)
Improve this page