writing-tips: examples of annotations within admonitions

practicalli · Jan 31, 2025 · f330185 · f330185
1 parent 8509878
commit f330185
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@
 - post: updated London Clojurians brief history
 - intro: semper scribus badge & button link logos
 - dev: megalinter runner upgrade make task
+- writing-tips: examples of annotations within admonitions
 
 ## Changed
 - mkdocs: correct github url for repo and edit link

diff --git a/docs/writing-tips.md b/docs/writing-tips.md
@@ -195,7 +195,7 @@ ls -la $HOME/Downloads  # (1)
 1.  :woman_raising_hand: I'm a code annotation! I can contain `code`, __formatted text__, images, ... basically anything that can be written in Markdown.
 
 
-Code blocks with annotation, add `!` after the annotation number to suppress the `#` character
+Code blocks with annotation, add `!` after the annotation number to suppress the `#` character, e.g. `# (1)`
 
 ```clojure
 (defn helper-function
@@ -245,6 +245,10 @@ jobs:
       ...
     ```
 
+!!! TIP "Annotations within an Admonition"
+    Codeblock annotations wrapped within an admonition should have the annotation description indented to be aligned with the admonition (i.e. 4 space indent)
+
+
 ### Highlight lines in code blocks
 
 Add highlight line meta data to a code block after the opening backticks and code block language.