Markdown Admonitions

What are admonitions

Admonitions (also known as “asides”) are useful for providing supportive and/or supplementary information related to your content.

How to use them

To use admonitions in Astro Cactus, wrap your Markdown content in a pair of triple colons :::. The first pair should also include the type of admonition you want to use.

For example, with the following Markdown:

:::note
Highlights information that users should take into account, even when skimming.
:::

Outputs:

Admonition Types

The following admonitions are currently supported:

• note
• tip
• important
• warning
• caution

Note

:::note
Highlights information that users should take into account, even when skimming.
:::

Tip

:::tip
Optional information to help a user be more successful.
:::

Important

:::important
Crucial information necessary for users to succeed.
:::

Caution

:::caution
Negative potential consequences of an action.
:::

Warning

:::warning
Critical content demanding immediate user attention due to potential risks.
:::

Customising the admonition title

You can customise the admonition title using the following markup:

:::note[My custom title]
This is a note with a custom title.
:::

Outputs:

GitHub Repository Cards

You can add dynamic cards that link to GitHub repositories, on page load, the repository information is pulled from the GitHub API.

You can also link a Github user:

To use this feature you just use the “Github” directive:

::github{repo="chrismwilliams/astro-theme-cactus"}

::github{user="withastro"}