add admonition examples

easybuilders · Oct 29, 2022 · 40b9738 · 40b9738
1 parent a148732
commit 40b9738
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md
@@ -27,4 +27,13 @@ There are broadly two types of code block used, which take different syntax high
 
 ## Admonitions
 
-Use [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) primarily for warnings (`!!! warning`) and info (`!!! info`).
+Use [admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) primarily for warnings and notes.
+For example:
+
+``` markdown
+!!! warning
+    This is a warning!
+
+!!! note
+    This is a note.
+```