TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-16 16:35:17 -04:00
Code Issues Packages Projects Releases Wiki Activity

Adapt anchorize.md to Goldmark

Browse Source
This commit is contained in:
Salim B 2021-03-25 14:57:12 +00:00 committed by Bjørn Erik Pedersen
parent 98aa190731
commit 4f2e92f2aa
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
content/en/functions/anchorize.md
View File

@ -1,6 +1,6 @@
--- ---
title: anchorize title: anchorize
description: Takes a string and sanitizes it the same way as Blackfriday does for markdown headers. 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 date: 2018-10-13
categories: [functions] categories: [functions]
menu: menu:
@ -13,8 +13,9 @@ workson: []
relatedfuncs: [humanize] relatedfuncs: [humanize]
--- ---
The template function uses the [`SanitizedAnchorName` logic from Blackfriday](https://github.com/russross/blackfriday#sanitized-anchor-names). 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 same sanitizing logic is used as the markdown parser, you can determine the ID of a header for linking with anchor tags.
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.
``` ```
{{anchorize "This is a header"}} → "this-is-a-header" {{anchorize "This is a header"}} → "this-is-a-header"