OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated slugify documentation

Browse Source 
Unicode, case-sensitive reference setting causes error below.

```
yaml.constructor.ConstructorError: expected a mapping node, but found scalar
```

Update related sections in the documentation to address this issue.

Newer Python-Markdown has `slugify_unicode` built-in, so this

```yaml
markdown_extensions:
  - toc:
      slugify: !!python/name:markdown.extensions.toc.slugify_unicode
```

also works for case-insensitive use cases.

Fixes: ee1e675da6 ("Update slug reference")
This commit is contained in:
Kuan-Yi Li 2024-03-29 16:54:53 +08:00 committed by Martin Donath
parent e71f00b4c9
commit 7d6d8d7a7c
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/setup/extensions/python-markdown-extensions.md
View File

@ -686,7 +686,7 @@ The following configuration options are supported:
<!-- md:option pymdownx.tabbed.slugify --> <!-- md:option pymdownx.tabbed.slugify -->
: <!-- md:default `toc.slugify` --> This option allows for : <!-- md:default `None` --> This option allows for
customization of the slug function. For some languages, the default may not customization of the slug function. For some languages, the default may not
produce good and readable identifiers – consider using another slug function produce good and readable identifiers – consider using another slug function
like for example those from [Python Markdown Extensions][Slugs]: like for example those from [Python Markdown Extensions][Slugs]:
@ -706,7 +706,7 @@ The following configuration options are supported:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:
- pymdownx.tabbed: - pymdownx.tabbed:
slugify: !!python/object/apply:pymdownx.slugs.slugify slugify: !!python/object/apply:pymdownx.slugs.slugify {}
``` ```
The other configuration options of this extension are not officially supported The other configuration options of this extension are not officially supported

2
docs/setup/extensions/python-markdown.md
View File

@ -257,7 +257,7 @@ The following configuration options are supported:
``` yaml ``` yaml
markdown_extensions: markdown_extensions:
- toc: - toc:
slugify: !!python/object/apply:pymdownx.slugs.slugify slugify: !!python/object/apply:pymdownx.slugs.slugify {}
``` ```
<!-- md:option toc.toc_depth --> <!-- md:option toc.toc_depth -->