From 9a59faaa23d50c4b8d6ac31a65c011df17afa6e9 Mon Sep 17 00:00:00 2001 From: thhsh-local Date: Mon, 21 Apr 2025 12:39:11 -0400 Subject: [PATCH] Admonitions _ common/default --- docs/handbook/meta/editing.md | 48 +++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/docs/handbook/meta/editing.md b/docs/handbook/meta/editing.md index f6051bf..d7e6c65 100644 --- a/docs/handbook/meta/editing.md +++ b/docs/handbook/meta/editing.md @@ -34,6 +34,54 @@ Currently, the available configured colors are based off the built-in admonition :octicons-flame-16:{ .tip-teal } Want to know how these colors work? Check out [:simple-forgejo: the CSS in the source](https://git.starcat.systems/starcatsys/about_docs/src/branch/main/docs/stylesheets/extra.css). +## Admonitions +Reference for using Admonitions: [:simple-materialformkdocs: Admonitions](https://squidfunk.github.io/mkdocs-material/reference/admonitions/#usage) + + + +### Common Admonition Usage +Here are some common admonitions, when you might use them, and quick code snippets that you can paste in. + +!!! 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 + Helpful advice for doing things better or more easily. + + ``` + !!! tip + Helpful advice for doing things better or more easily. + ``` + +!!! warning + Advises about risks or negative outcomes of certain actions. + + ``` + !!! warning + Advises about risks or negative outcomes of certain actions. + ``` + +!!! danger + Urgent info that needs immediate user attention to avoid problems. + + ``` + !!! danger + Urgent info that needs immediate user attention to avoid problems. + ``` + +!!! bug + Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed. + + ``` + !!! bug + Information about a known bug in a current version. Whenever possible, provide a link to the issue report. Place a link back to the page with this admonition, in the issue report so that the admonition can be removed when the bug is closed. + ``` ---