From c7ba758a4e175f827f21eb30446f1bc613e93955 Mon Sep 17 00:00:00 2001 From: Lam Nguyen Date: Thu, 13 Mar 2025 10:26:16 -0700 Subject: [PATCH 1/2] chore: Update call-out shortcode usage in Contributing --- CONTRIBUTING_DOCS.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING_DOCS.md b/CONTRIBUTING_DOCS.md index 2947cc8bd..903db015f 100644 --- a/CONTRIBUTING_DOCS.md +++ b/CONTRIBUTING_DOCS.md @@ -133,12 +133,14 @@ Supported callouts: - `caution` - `warning` -You can also create custom callouts using the `call-out` shortcode `{{< call-out "type" "header" "font-awesome icon >}}`. For example: +You can also create custom callouts using the `call-out` shortcode `{{< call-out "type position" "header" "font-awesome icon >}}`. For example: ```md -{{}} +{{}} ``` +By default, all custom callouts are inlined unless `side-callout` is passed in to put the callout on the right of the content. + Here are some other shortcodes: - `fa`: Inserts a Font Awesome icon From 445906b819c62e80997e5b844c88cd2a24d5d4d7 Mon Sep 17 00:00:00 2001 From: Lam <150060045+lamATnginx@users.noreply.github.com> Date: Thu, 13 Mar 2025 10:48:06 -0700 Subject: [PATCH 2/2] Update with suggestion Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com> --- CONTRIBUTING_DOCS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING_DOCS.md b/CONTRIBUTING_DOCS.md index 903db015f..e8b50661e 100644 --- a/CONTRIBUTING_DOCS.md +++ b/CONTRIBUTING_DOCS.md @@ -139,7 +139,7 @@ You can also create custom callouts using the `call-out` shortcode `{{< call-out {{}} ``` -By default, all custom callouts are inlined unless `side-callout` is passed in to put the callout on the right of the content. +By default, all custom callouts are included inline, unless you add `side-callout` which places the callout to the right of the content. Here are some other shortcodes: