Annotations Material

Syntax

Form	Syntax	Usage
Paragraph	`Text (1)` then `{ .annotate }`	Inline marker.
List	`1. Content`	Bubble content with Markdown.
Nested	annotation item with `{ .annotate }`	Annotation inside an annotation.
Admonition	`!!! note annotate "Title (1)"`	Annotation inside a block.
Tabs	`=== "Tab"` with `(1)`	Annotation inside a tab.
Quote	`> Quote (1)`	Annotation in a blockquote.

In a paragraph

SyntaxResult

Text with an annotation. (1)
{ .annotate }

1.  Annotation content with `code`, **bold** and [a link](#).

Text with an annotation. 1

Nested annotation

SyntaxResult

Text with nested annotations. (1)
{ .annotate }

1.  Parent annotation. (1)
    { .annotate }

    1.  Nested annotation with **Markdown**.

Text with nested annotations. 1

In an admonition

SyntaxResult

!!! note annotate "Annotated title (1)"
    The admonition body can also contain a marker. (2)

1.  Annotation placed in the title.
2.  Annotation placed in the body.

In tabs

SyntaxResult

=== "JavaScript"

    ```js
    const mode = "documentation"; // (1)
    ```

    1.  This annotation belongs only to the JavaScript tab.

=== "YAML"

    ```yaml
    mode: documentation # (1)
    ```

    1.  This annotation belongs only to the YAML tab.

JavaScriptYAML

const mode = "documentation"; // 1This annotation belongs only to the JavaScript tab.

mode: documentation # 1This annotation belongs only to the YAML tab.

With a quote

SyntaxResult

> A quote can receive an annotation to explain a source or a nuance. (1)
{ .annotate }

1.  This form reuses the idea of the MkDocs Material `annotate` container.

A quote can receive an annotation to explain a source or a nuance. 1