Skip to content

Commit 55e1844

Browse files
authored
Docs: slugify.paths replaces whitespace with - not _ (#2474)
Minor documentation fix: when `slugify.paths` is set to `"safe"`, whitespaces are replaced with a hyphen, not an underscore.
1 parent 0ec6a6c commit 55e1844

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/content/documentation/content/linking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight = 50
66
## Heading id and anchor insertion
77
While rendering the Markdown content, a unique id will automatically be assigned to each heading.
88
This id is created by converting the heading text to a [slug](https://en.wikipedia.org/wiki/Semantic_URL#Slug) if `slugify.anchors` is set to `"on"` (the default).
9-
If `slugify.paths` is set to `"safe"`, whitespaces are replaced by `_` and the following characters are stripped: `#`, `%`, `<`, `>`, `[`, `]`, `(`, `)`, \`, `^`, `{`, `|`, `}`.
9+
If `slugify.paths` is set to `"safe"`, whitespaces are replaced by `-` and the following characters are stripped: `#`, `%`, `<`, `>`, `[`, `]`, `(`, `)`, \`, `^`, `{`, `|`, `}`.
1010
If `slugify.paths` is set to `"off"`, no modifications are made, and you may be left with nominally illegal ids.
1111
A number is appended at the end if the slug already exists for that article.
1212
For example:

0 commit comments

Comments
 (0)