# Tooltips¶

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.

## Configuration¶

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 mkdocs.yml:

markdown_extensions:
- abbr
- attr_list
- pymdownx.snippets


### Improved tooltips¶

Sponsors only · insiders-4.15.0 · Experimental

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 mkdocs.yml:

theme:
features:
- content.tooltips


Now, tooltips will be rendered for the following elements:

• Content – elements with a title, permalinks and copy-to-clipboard button
• Navigation – links that are shortened with ellipsis, i.e. ...

## Usage¶

The Markdown syntax allows to specify a title for each link, which will render as a beautiful tooltip when improved tooltips are enabled. Add a tooltip to a link with the following lines:

[Hover me](https://example.com "I'm a tooltip!")


[Hover me][example]

[example]: https://example.com "I'm a tooltip!"


For all other elements, a title can be added by using the Attribute Lists extension:

Icon with tooltip
:material-information-outline:{ title="Important information" }


Abbreviations can be defined by using a special syntax similar to links and footnotes, starting with a * and immediately followed by the term or acronym to be associated in square brackets:

Text with abbreviations
The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium


The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language

markdown_extensions:

1. It's highly recommended to put the Markdown file containing the abbreviations outside of the docs folder (here, a folder with the name includes is used), as MkDocs might otherwise complain about an unreferenced file.