From 2cc76e6ae701ee6c0f307629fd5563c17cf28de6 Mon Sep 17 00:00:00 2001
From: Dimitri FERT <dimitri.fert@gmail.com>
Date: Tue, 14 May 2024 10:32:19 +0200
Subject: [PATCH] feat: add doc on how to use admonitions

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 75e0a54c0..6f99c1113 100644
--- a/README.md
+++ b/README.md
@@ -201,6 +201,16 @@ If you need to add internal anchor links from your article to other article of o
 
 > Warning: Don't add html in your markdown, you don't have to override the blog template in the markdown.
 
+This blog supports admonitions pannels `warning` ; `info` ; `tip` and `note` to generate colored panels.
+When using `<div>` attribute `markdown="1"` text block is rendered as Markdown. The first line must be left empty, else the block will be rendered as html
+
+```md
+<div class="admonition warning" markdown="1"><p class="admonition-title">Your Panel Title</p>
+
+Your panel text.
+</div>
+```
+
 **5 - Add your pull request**
 
 Create your branch and add your pull request.