Admonitions (or “call-outs”) are a choice writers can use to include side content in an article without interrupting the document flow.
Formatting
To add an admonition to a page, you can use the following code. The TITLE must be specified, if you don’t want a specific title you can set it to the same text as the TYPE (see below) in title case, e.g. Note. The ENCLOSED TEXT should be Markdown formatted.
Admonition
<div class="admonition TYPE" markdown>
<p class="admonition-title">TITLE</p>
ENCLOSED TEXT
</div>
Collapsible admonition
<details class="TYPE" markdown>
<summary>TITLE</summary>
ENCLOSED TEXT
</details>
Types of admonition
You would replace TYPE above with the name of a type below.
Standard admonitions
This website documents all the standard types supported by mkdocs-material:
For example, replacing TYPE with note would render the following:
Special types
recommendation
This format is used to generate recommendation cards. Notably it is missing the <p class="admonition-title"> element:
<div class="admonition recommendation" markdown>
{ align=right }
**PhotoPrism** is a self-hostable platform for managing photos. It supports album syncing and sharing as well as a variety of other [features](https://photoprism.app/features). It does not include E2EE, so it's best hosted on a server that you trust and is under your control.
[:octicons-home-16: Homepage](https://photoprism.app){ .md-button .md-button--primary }
[:octicons-eye-16:](https://photoprism.app/privacy){ .card-link title="Privacy Policy" }
[:octicons-info-16:](https://photoprism.app/kb){ .card-link title=Documentation}
[:octicons-code-16:](https://github.com/photoprism){ .card-link title="Source Code" }
<details class="downloads" markdown>
<summary>Downloads</summary>
- [:simple-github: GitHub](https://github.com/photoprism)
</details>
</div>
downloads
This is a special type of collapsible admonition, used to generate the download links section. It is only used within recommendation cards, as shown in the example above.
<details class="downloads" markdown>
<summary>Downloads</summary>
- [:simple-googleplay: Google Play](https://play.google.com/store/apps/details?id=ch.protonmail.android)
- [:simple-appstore: App Store](https://apps.apple.com/app/id979659905)
- [:simple-github: GitHub](https://github.com/ProtonMail/proton-mail-android/releases)
- [:fontawesome-brands-windows: Windows](https://proton.me/mail/bridge#download)
- [:simple-apple: macOS](https://proton.me/mail/bridge#download)
- [:simple-linux: Linux](https://proton.me/mail/bridge#download)
- [:octicons-browser-16: Web](https://mail.proton.me)
</details>
Old format
Throughout the site, you may see some admonitions formatted similarly to these examples:
!!! note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
??? example "Custom Title"
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.
This format is no longer used going forward, because it is incompatible with newer versions of our translation software at Crowdin. When adding a new page to the site, only the newer HTML-based format should be used.
There is no rush to convert admonitions with the old format to the new format. Pages currently using this formatting should continue to work, but we will be updating them to use the newer HTML-based format above over time as we continue to update the site.
The above examples should be replaced with a regular admonition (!!!) and a collapsible admonition (???), respectively.
Last edited by @jonah 2025-05-06T22:38:01Z
Check document
Perform check on document: