diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a951f2..6e1c499 100644 --- 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 index 58f86b0..69ae1be 100644 --- 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.