Material for MkDocs makes it trivial to add tooltips to links, abbreviations and all other elements, which allows for implementing glossary-like functionality, as well as small hints that are shown when the user hovers or focuses an element.
This configuration enables support for tooltips and abbreviations and allows to build a simple glossary, sourcing definitions from a central location. Add the following lines to
See additional configuration options:
When improved tooltips are enabled, Material for MkDocs replaces the browser's rendering logic for
title attribute with beautiful little tooltips. Add the following lines to
Now, tooltips will be rendered for the following elements:
- Content – elements with a
title, permalinks and copy-to-clipboard button
- Header – home button, header title, color palette switch and repository link
- Navigation – links that are shortened with ellipsis, i.e.
Tooltips can also be added to link references:
For all other elements, a
title can be added by using the Attribute Lists extension:
The HTML specification is maintained by the W3C.
Adding a glossary¶
It's highly recommended to put the Markdown file containing the abbreviations outside of the
docsfolder (here, a folder with the name
includesis used), as MkDocs might otherwise complain about an unreferenced file. ↩