hugo/docs/content/en/functions/anchorize.md

944 B

title description date categories menu keywords signature hugoversion workson relatedfuncs
anchorize Takes a string and sanitizes it the same way as Blackfriday does for markdown headers. 2018-10-13
functions
docs
parent
functions
markdown
strings
anchorize INPUT
0.39
humanize

The template function uses the SanitizedAnchorName logic from Blackfriday. Since the same sanitizing logic is used as the markdown parser, you can determine the ID of a header for linking with anchor tags.

{{anchorize "This is a header"}} → "this-is-a-header"
{{anchorize "This is also          a header"}} → "this-is-also-a-header"
{{anchorize "main.go"}} → "main-go"
{{anchorize "Article 123"}} → "article-123"
{{anchorize "<- Let's try this, shall we?"}} → "let-s-try-this-shall-we"
{{anchorize "Hello, 世界"}} → "hello-世界"