Skip to main content

Admonitions

Added in eventcatalog@2.16.6

The admonitions syntax is used to render a block of text with a specific style. You can use it to highlight important information, warnings, or other types of content.

Support​

The markdown syntax is supported in all pages in EventCatalog.

Usage​

Basic Example

---
#event frontmatter
---

:::note
Some content with _Markdown_ syntax. Check [this api](https://eventcatalog.dev/).
:::

:::tip
Some content with _Markdown_ syntax. Check [this api](https://eventcatalog.dev/).
:::

:::warning
Some content with _Markdown_ syntax. Check [this api](https://eventcatalog.dev/).
:::

:::danger
Some content with _Markdown_ syntax. Check [this api](https://eventcatalog.dev/).
:::

Output example in EventCatalog​

Example output