7.3 KiB
| icon |
|---|
| material/plus-circle |
Annotations
One of the flagship features of Material for MkDocs is the ability to inject annotations – little markers that can be added almost anywhere in a document and expand a tooltip containing arbitrary Markdown on click or keyboard focus.
Configuration
This configuration allows to add annotations to all inline- and block-level
elements, as well as code blocks, and nest annotations inside each other. Add
the following lines to mkdocs.yml:
markdown_extensions:
- attr_list
- md_in_html
- pymdownx.superfences
See additional configuration options:
-
Attribute Lists{ data-preview="" }
-
Markdown in HTML{ data-preview="" }
-
SuperFences{ data-preview="" }
Annotation icons
The annotation icon can be changed to any icon bundled with the theme, or even
a custom icon, e.g. to material/arrow-right-circle:. Simply add the following
lines to mkdocs.yml:
theme:
icon:
annotation: material/arrow-right-circle # (1)!
-
Enter a few keywords to find the perfect icon using our icon search and click on the shortcode to copy it to your clipboard:
Some popular choices:
-
:material-plus-circle: -
material/plus-circle -
:material-circle-medium: -
material/circle-medium -
:material-record-circle: -
material/record-circle -
:material-arrow-right-circle: -
material/arrow-right-circle -
:material-arrow-right-circle-outline: -
material/arrow-right-circle-outline -
:material-chevron-right-circle: -
material/chevron-right-circle -
:material-star-four-points-circle: -
material/star-four-points-circle -
:material-plus-circle-outline: -
material/plus-circle-outline
Usage
Using annotations
Annotations consist of two parts: a marker, which can be placed anywhere in
a block marked with the annotate class, and content located in a list below
the block containing the marker:
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }
1. :man_raising_hand: I'm an annotation! I can contain `code`, __formatted
text__, images, ... basically anything that can be expressed in Markdown.
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit. { .annotate }
- :man_raising_hand: I'm an annotation! I can contain
code, formatted text, images, ... basically anything that can be written in Markdown.
Note that the annotate class must only be added to the outermost block. All
nested elements can use the same list to define annotations, except when
annotations are nested themselves.
in annotations
When SuperFences is enabled, annotations can be nested inside annotations by
adding the annotate class to the list item hosting the annotation content,
repeating the process:
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }
1. :man_raising_hand: I'm an annotation! (1)
{ .annotate }
1. :woman_raising_hand: I'm an annotation as well!
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit. { .annotate }
-
:man_raising_hand: I'm an annotation! (1) { .annotate style="margin-bottom: 0" }
- :woman_raising_hand: I'm an annotation as well!
in admonitions
The titles and bodies of admonitions can also host annotations by adding the
annotate modifier after the type qualifier, which is similar to how
inline blocks work:
!!! note annotate "Phasellus posuere in sem ut cursus (1)"
Lorem ipsum dolor sit amet, (2) consectetur adipiscing elit. Nulla et
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa.
1. :man_raising_hand: I'm an annotation!
2. :woman_raising_hand: I'm an annotation as well!
!!! note annotate "Phasellus posuere in sem ut cursus (1)"
Lorem ipsum dolor sit amet, (2) consectetur adipiscing elit. Nulla et
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa.
- :man_raising_hand: I'm an annotation!
- :woman_raising_hand: I'm an annotation as well!
in content tabs
Content tabs can host annotations by adding the annotate class to the block
of a dedicated content tab (and not to the container, which is not supported):
=== "Tab 1"
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }
1. :man_raising_hand: I'm an annotation!
=== "Tab 2"
Phasellus posuere in sem ut cursus (1)
{ .annotate }
1. :woman_raising_hand: I'm an annotation as well!
=== "Tab 1"
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
{ .annotate }
1. :man_raising_hand: I'm an annotation!
=== "Tab 2"
Phasellus posuere in sem ut cursus (1)
{ .annotate }
1. :woman_raising_hand: I'm an annotation as well!
in everything else
The Attribute Lists extension is the key ingredient for adding annotations to
most elements, but it has some limitations. However, it's always possible to
leverage the Markdown in HTML extension to wrap arbitrary elements with a
div with the annotate class:
<div class="annotate" markdown>
> Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
</div>
1. :man_raising_hand: I'm an annotation!
Lorem ipsum dolor sit amet, (1) consectetur adipiscing elit.
- :man_raising_hand: I'm an annotation!
With this trick, annotations can also be added to blockquotes, lists, and many other elements that are not supported by the Attribute Lists extension. Furthermore, note that code blocks follow different semantics.
!!! warning "Known limitations"
Please note that annotations currently don't work in [data tables] as
reported in #3453, as data tables are scrollable elements and positioning
is very tricky to get right. This might be fixed in the future.