From 40b9738a2bb1b743ba818aa83ce3a2c9f3011b21 Mon Sep 17 00:00:00 2001 From: James Carpenter Date: Sat, 29 Oct 2022 01:04:38 +0100 Subject: [PATCH] add admonition examples --- STYLE_GUIDE.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index 0b78f13bd..64fb787c3 100644 --- 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. +```