Admonitions in MyST¶

The MyST forms of the specimens on Admonitions, each rendered live by this page’s own Markdown parser.

Notes, tips and hints¶

Notes, tips and hints

```{note}
Supplementary information the reader may skip.
```

```{tip}
A better way to do what the text describes.
```

```{hint}
A nudge towards the answer.
```

```{important}
Information the reader must not miss.
```

```{seealso}
Related material the reader may want next.
```

Note

Supplementary information the reader may skip.

Tip

A better way to do what the text describes.

Hint

A nudge towards the answer.

Important

Information the reader must not miss.

Cautions, warnings and errors¶

Cautions, warnings and errors

```{attention}
Read this before you go on.
```

```{caution}
Proceed carefully.
```

```{warning}
This can go wrong.
```

```{danger}
This can do harm.
```

```{error}
This went wrong.
```

Attention

Read this before you go on.

Caution

Proceed carefully.

Warning

This can go wrong.

Danger

This can do harm.

Error

This went wrong.

A custom admonition¶

A custom admonition

```{admonition} Before you *begin*
Check that the project builds.
```

Before you begin

Check that the project builds.

Collapsible admonitions¶

Collapsible admonitions

```{note}
:collapsible: closed

Folded until the reader opens it.
```

```{tip}
:collapsible: open

Open until the reader folds it.
```

Note

Folded until the reader opens it.

Tip

Open until the reader folds it.