From be9b6b3a1e2038ea0a985ebd37fb18a661bddd04 Mon Sep 17 00:00:00 2001 From: Jacky Zhao Date: Fri, 23 Feb 2024 09:32:08 -0800 Subject: [PATCH] fix(docs): make docs accurate to callout behaviour (closes #920) --- docs/features/callouts.md | 63 +++++++++++++++++---------------------- 1 file changed, 27 insertions(+), 36 deletions(-) diff --git a/docs/features/callouts.md b/docs/features/callouts.md index d73979284..3fefda2e6 100644 --- a/docs/features/callouts.md +++ b/docs/features/callouts.md @@ -55,50 +55,41 @@ By default, custom callouts are handled by applying the `note` style. To make fa > > > > > [!example] You can even use multiple layers of nesting. -> [!EXAMPLE] Examples -> -> Aliases: example +> [!note] +> Aliases: "note" -> [!note] Notes -> -> Aliases: note +> [!abstract] +> Aliases: "abstract", "summary", "tldr" -> [!abstract] Summaries -> -> Aliases: abstract, summary, tldr +> [!info] +> Aliases: "info" -> [!info] Info -> -> Aliases: info, todo +> [!todo] +> Aliases: "todo" -> [!tip] Hint -> -> Aliases: tip, hint, important +> [!tip] +> Aliases: "tip", "hint", "important" -> [!success] Success -> -> Aliases: success, check, done +> [!success] +> Aliases: "success", "check", "done" -> [!question] Question -> -> Aliases: question, help, faq +> [!question] +> Aliases: "question", "help", "faq" -> [!warning] Warning -> -> Aliases: warning, caution, attention +> [!warning] +> Aliases: "warning", "attention", "caution" -> [!failure] Failure -> -> Aliases: failure, fail, missing +> [!failure] +> Aliases: "failure", "missing", "fail" -> [!danger] Error -> -> Aliases: danger, error +> [!danger] +> Aliases: "danger", "error" -> [!bug] Bug -> -> Aliases: bug +> [!bug] +> Aliases: "bug" -> [!quote] Quote -> -> Aliases: quote, cite +> [!example] +> Aliases: "example" + +> [!quote] +> Aliases: "quote", "cite"