Skip to content

Commit 772e159

Browse files
committed
Switched tags plugin to generate Unicode-aware slugs
1 parent 058b32f commit 772e159

1 file changed

Lines changed: 14 additions & 25 deletions

File tree

docs/plugins/tags.md

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -176,35 +176,24 @@ The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
176176

177177
<!-- md:sponsors -->
178178
<!-- md:version insiders-4.25.0 -->
179-
<!-- md:default [`toc.slugify`][toc.slugify] -->
179+
<!-- md:default [`pymdownx.slugs.slugify`][pymdownx.slugs.slugify] -->
180180

181-
Use this setting to change the function to use for generating URL-compatible
182-
slugs from tags. [Python Markdown Extensions] comes with a Unicode-aware
183-
[`slugify`][pymdownx.slugs.slugify] function:
181+
Use this setting to change the function for generating URL-compatible slugs
182+
from post titles. By default, the [`slugify`][pymdownx.slugs.slugify] function
183+
from [Python Markdown Extensions] is used as follows:
184184

185-
=== "Unicode"
186-
187-
``` yaml
188-
plugins:
189-
- tags:
190-
tags_slugify: !!python/object/apply:pymdownx.slugs.slugify
191-
kwds:
192-
case: lower
193-
```
194-
195-
=== "Unicode, case-sensitive"
196-
197-
``` yaml
198-
plugins:
199-
- tags:
200-
tags_slugify: !!python/object/apply:pymdownx.slugs.slugify
201-
```
185+
``` yaml
186+
plugins:
187+
- blog:
188+
post_slugify: !!python/object/apply:pymdownx.slugs.slugify
189+
kwds:
190+
case: lower
191+
```
202192

203-
When your project features non-European languages, it's advisable to use this
204-
configuration. Of course, you can also provide a custom slugification function
205-
for more granular control.
193+
The default configuration is Unicode-aware and should produce good slugs for all
194+
languages. Of course, you can also provide a custom slugification function for
195+
more granular control.
206196

207-
[toc.slugify]: https://github.com/Python-Markdown/markdown/blob/1337d0891757e192165668d2606db36cf08e65a9/markdown/extensions/toc.py#L26-L33
208197
[pymdownx.slugs.slugify]: https://github.com/facelessuser/pymdown-extensions/blob/01c91ce79c91304c22b4e3d7a9261accc931d707/pymdownx/slugs.py#L59-L65
209198
[Python Markdown Extensions]: https://facelessuser.github.io/pymdown-extensions/extras/slugs/
210199

0 commit comments

Comments
 (0)