Skip to content

Commit 8f382d9

Browse files
committed
Added documentation for permanent link title
1 parent 9d1f5c9 commit 8f382d9

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/setup/extensions/python-markdown.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,19 @@ The following configuration options are supported:
236236
permalink: ⚓︎
237237
```
238238

239+
`permalink_title`{ #toc-permalink-title }
240+
241+
: :octicons-milestone-24: Default: `Permanent link` – This option sets the
242+
title of the anchor link which is shown on hover and read by screen readers.
243+
For accessibility reasons, it might be beneficial to change it to a more
244+
discernable name, stating that the anchor links to the section itself:
245+
246+
``` yaml
247+
markdown_extensions:
248+
- toc:
249+
permalink_title: Anchor link to this section for reference
250+
```
251+
239252
`slugify`{ #toc-slugify }
240253

241254
: :octicons-milestone-24: Default: `headerid.slugify` – This option allows for

0 commit comments

Comments
 (0)