summaryrefslogtreecommitdiff
path: root/src/content/post/markdown-elements/admonitions.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/content/post/markdown-elements/admonitions.md')
-rw-r--r--src/content/post/markdown-elements/admonitions.md115
1 files changed, 115 insertions, 0 deletions
diff --git a/src/content/post/markdown-elements/admonitions.md b/src/content/post/markdown-elements/admonitions.md
new file mode 100644
index 0000000..d7cf5f9
--- /dev/null
+++ b/src/content/post/markdown-elements/admonitions.md
@@ -0,0 +1,115 @@
+---
+title: "Markdown Admonitions"
+description: "This post showcases using the markdown admonition feature in Astro Cactus"
+publishDate: "25 Aug 2024"
+updatedDate: "7 Jan 2025"
+tags: ["markdown", "admonitions"]
+---
+
+## What are admonitions
+
+Admonitions (also known as “asides”) are useful for providing supportive and/or supplementary information related to your content.
+
+## How to use them
+
+To use admonitions in Astro Cactus, wrap your Markdown content in a pair of triple colons `:::`. The first pair should also include the type of admonition you want to use.
+
+For example, with the following Markdown:
+
+```md
+:::note
+Highlights information that users should take into account, even when skimming.
+:::
+```
+
+Outputs:
+
+:::note
+Highlights information that users should take into account, even when skimming.
+:::
+
+## Admonition Types
+
+The following admonitions are currently supported:
+
+- `note`
+- `tip`
+- `important`
+- `warning`
+- `caution`
+
+### Note
+
+```md
+:::note
+Highlights information that users should take into account, even when skimming.
+:::
+```
+
+:::note
+Highlights information that users should take into account, even when skimming.
+:::
+
+### Tip
+
+```md
+:::tip
+Optional information to help a user be more successful.
+:::
+```
+
+:::tip
+Optional information to help a user be more successful.
+:::
+
+### Important
+
+```md
+:::important
+Crucial information necessary for users to succeed.
+:::
+```
+
+:::important
+Crucial information necessary for users to succeed.
+:::
+
+### Caution
+
+```md
+:::caution
+Negative potential consequences of an action.
+:::
+```
+
+:::caution
+Negative potential consequences of an action.
+:::
+
+### Warning
+
+```md
+:::warning
+Critical content demanding immediate user attention due to potential risks.
+:::
+```
+
+:::warning
+Critical content demanding immediate user attention due to potential risks.
+:::
+
+## Customising the admonition title
+
+You can customise the admonition title using the following markup:
+
+```md
+:::note[My custom title]
+This is a note with a custom title.
+:::
+```
+
+Outputs:
+
+:::note[My custom title]
+This is a note with a custom title.
+:::