mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
d276e901b3
63386081c update cSpell config update 15c76494b Update cSpell custom dictionary (#1694) 34f3167b7 Update image processing (#1625) 7462cc798 fix: pipes in sample code break table creation (#1686) 48736447e Update anchorize.md 2ff0bd10b netlify: Hugo 0.95.0 0fc1d21b2 Update configuration.md 41855e372 Fix #1682 8c663433e Update related.md 7aa072eab netlify: Hugo 0.94.2 1682c7ee7 Update render-hooks.md ce1283cc4 Move the Render Hooks doc to its own page bbbbfbfc6 Update configuration-markup.md 92d91a316 Update configuration-markup.md 2e8068823 Update configuration-markup.md ff2dbca60 Update configuration-markup.md 89d8e5d65 Add code block documenation e993539f0 Update shortcodes.md c1b28dbfe netlify: Hugo 0.94.1 81b8c9b83 Merge branch 'tempv0.94.1' 4763b3d50 docs: Regenerate CLI docs b18463971 netlify: Bump to Hugo 0.94.0 4152ebc1d Merge branch 'tempv0.94.0' ba3a11ac2 docs: Regenerate docshelper e64016d13 docs: Regenerate docshelper 29180e4d2 add `.html` suffix to partial usage and references 3213e00f2 Docs tidy-up 6cfcae4b7 docs: Regenerate CLI docs 8a6cd0b4d docs: Regenerate docshelper b20ab262f Merge commit 'd706529720b3b2ccb99719ccd578062ca25a0cc2' git-subtree-dir: docs git-subtree-split: 63386081c55de6a7f97adde564a9cfc2ad326119
27 lines
1.6 KiB
Markdown
27 lines
1.6 KiB
Markdown
---
|
|
title: anchorize
|
|
description: Takes a string and sanitizes it the same way as the [`defaultMarkdownHandler`](https://gohugo.io/getting-started/configuration-markup#configure-markup) does for markdown headers.
|
|
date: 2018-10-13
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
keywords: [markdown,strings]
|
|
signature: ["anchorize INPUT"]
|
|
hugoversion: "0.39"
|
|
workson: []
|
|
relatedfuncs: [humanize]
|
|
---
|
|
|
|
If [Goldmark](https://gohugo.io/getting-started/configuration-markup#goldmark) is set as `defaultMarkdownHandler`, the sanitizing logic adheres to the setting [`markup.goldmark.parser.autoHeadingIDType`](https://gohugo.io/getting-started/configuration-markup#goldmark). If [Blackfriday](https://gohugo.io/getting-started/configuration-markup#blackfriday) is set as `defaultMarkdownHandler`, this template function uses the [`SanitizedAnchorName` logic from Blackfriday](https://github.com/russross/blackfriday#sanitized-anchor-names) (the same applies when `markup.goldmark.parser.autoHeadingIDType` is set to `blackfriday`).
|
|
|
|
Since the `defaultMarkdownHandler` and this template function use the same sanitizing logic, you can use the latter to determine the ID of a header for linking with anchor tags.
|
|
|
|
```go-html-template
|
|
{{ anchorize "This is a header" }} --> "this-is-a-header"
|
|
{{ anchorize "This is also a header" }} --> "this-is-also----a-header"
|
|
{{ anchorize "main.go" }} --> "maingo"
|
|
{{ anchorize "Article 123" }} --> "article-123"
|
|
{{ anchorize "<- Let's try this, shall we?" }} --> "--lets-try-this-shall-we"
|
|
{{ anchorize "Hello, 世界" }} --> "hello-世界"
|
|
```
|