mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-06-14 11:52:32 +03:00
Added documentation for permanent link title
This commit is contained in:
parent
9d1f5c9025
commit
8f382d9799
@ -236,6 +236,19 @@ The following configuration options are supported:
|
||||
permalink: ⚓︎
|
||||
```
|
||||
|
||||
`permalink_title`{ #toc-permalink-title }
|
||||
|
||||
: :octicons-milestone-24: Default: `Permanent link` – This option sets the
|
||||
title of the anchor link which is shown on hover and read by screen readers.
|
||||
For accessibility reasons, it might be beneficial to change it to a more
|
||||
discernable name, stating that the anchor links to the section itself:
|
||||
|
||||
``` yaml
|
||||
markdown_extensions:
|
||||
- toc:
|
||||
permalink_title: Anchor link to this section for reference
|
||||
```
|
||||
|
||||
`slugify`{ #toc-slugify }
|
||||
|
||||
: :octicons-milestone-24: Default: `headerid.slugify` – This option allows for
|
||||
|
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue
Block a user