Markdown Plugins Guide

Introduction

admonitions

Admonitions are a block element. The titles can include inline markdown and the body can include any block markdown except another admonition.

The general syntax is

:::keyword optional title
some content
:::

These are all the available admonitions

:::tip You should read this. admonitions is great! :::

:::important Really, you should read that tip. :::

:::note These things are nice to know, y’know :::

:::caution Watch out! you still haven’t read the tip :::

:::warning You shall not pass through this if you haven’t read the tip :::