Skip to content

Commit 93e5c45

Browse files
lamATnginxmjang
authored andcommitted
Update call-out shortcode usage in Contributing (#286)
* chore: Update call-out shortcode usage in Contributing * Update with suggestion Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com> --------- Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>
1 parent ca3874c commit 93e5c45

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING_DOCS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,12 +133,14 @@ Supported callouts:
133133
- `caution`
134134
- `warning`
135135

136-
You can also create custom callouts using the `call-out` shortcode `{{< call-out "type" "header" "font-awesome icon >}}`. For example:
136+
You can also create custom callouts using the `call-out` shortcode `{{< call-out "type position" "header" "font-awesome icon >}}`. For example:
137137

138138
```md
139-
{{<call-out "important" "JWT file required for upgrade" "fa fa-exclamation-triangle">}}
139+
{{<call-out "important side-callout" "JWT file required for upgrade" "fa fa-exclamation-triangle">}}
140140
```
141141

142+
By default, all custom callouts are included inline, unless you add `side-callout` which places the callout to the right of the content.
143+
142144
Here are some other shortcodes:
143145

144146
- `fa`: Inserts a Font Awesome icon

0 commit comments

Comments
 (0)