HUGO
Menu
GitHub 88319 stars Mastodon

urls.Anchorize

Returns the given string, sanitized for usage in an HTML id attribute.

Syntax

urls.Anchorize INPUT

Returns

string

Alias

anchorize

The anchorize and urlize functions are similar:

  • Use the anchorize function to generate an HTML id attribute value
  • Use the urlize function to sanitize a string for usage in a URL

For example:

{{ $s := "A B C" }}
{{ $s | anchorize }} → a-b-c
{{ $s | urlize }} → a-b-c

{{ $s := "a b   c" }}
{{ $s | anchorize }} → a-b---c
{{ $s | urlize }} → a-b-c

{{ $s := "< a, b, & c >" }}
{{ $s | anchorize }} → -a-b--c-
{{ $s | urlize }} → a-b-c

{{ $s := "main.go" }}
{{ $s | anchorize }} → maingo
{{ $s | urlize }} → main.go

{{ $s := "Hugö" }}
{{ $s | anchorize }} → hugö
{{ $s | urlize }} → hug%C3%B6

The ursl.Anchorize function sanitizes the resulting string per the autoIDType setting in your project configuration.