From 4f1d68bfeef7afab94de6c67b6107bbccfed0909 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20R=C3=BCger?= Date: Wed, 18 Jun 2025 23:36:11 +0200 Subject: [PATCH] Document admonitions feature --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e0581c9..af37990 100644 --- a/README.md +++ b/README.md @@ -741,6 +741,16 @@ All you need is a codeblock marked as "d2". X -> Y ``` +### MkDocs' Admonitions + +Optionally you can enable mkdocs-style [Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) via `--features="mkdocsadmonitions"`. + +When enabled, this renders note, warning, tip, info admonitions as Confluence alerts. + +```markdown +!!! note +``` + ## Installation ### Homebrew