mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
38 lines
1 KiB
Markdown
38 lines
1 KiB
Markdown
|
---
|
||
|
|
title: urls.Anchorize
|
||
|
|
description: Returns the given string, sanitized for usage in an HTML id attribute.
|
||
|
|
categories: []
|
||
|
|
keywords: []
|
||
|
|
action:
|
||
|
|
aliases: [anchorize]
|
||
|
|
related:
|
||
|
|
- functions/urls/URLize
|
||
|
|
returnType: string
|
||
|
|
signatures: [urls.Anchorize INPUT]
|
||
|
|
aliases: [/functions/anchorize]
|
||
|
|
---
|
||
|
|
|
||
|
|
{{% include "/functions/urls/_common/anchorize-vs-urlize.md" %}}
|
||
|
|
|
||
|
|
## Sanitizing logic
|
||
|
|
|
||
|
|
With the default markdown renderer, Goldmark, the sanitizing logic is controlled by your site configuration:
|
||
|
|
|
||
|
|
{{< code-toggle file=hugo >}}
|
||
|
|
[markup.goldmark.parser]
|
||
|
|
autoHeadingIDType = 'github'
|
||
|
|
{{< /code-toggle >}}
|
||
|
|
|
||
|
|
This controls the behavior of the `anchorize` function and the generation of heading IDs when rendering markdown to HTML.
|
||
|
|
|
||
|
|
Set `autoHeadingIDType` to one of:
|
||
|
|
|
||
|
|
github
|
||
|
|
: Compatible with GitHub. This is the default, and strongly recommended.
|
||
|
|
|
||
|
|
github-ascii
|
||
|
|
: Similar to the "github" setting, but removes non-ASCII characters.
|
||
|
|
|
||
|
|
blackfriday
|
||
|
|
: Provided for backwards compatibility with Hugo v0.59.1 and earlier. This option will be removed in a future release.
|