Skip to content

Update call-out shortcode usage in Contributing #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 13, 2025
Merged

Update call-out shortcode usage in Contributing #286

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7ba758
chore: Update call-out shortcode usage in Contributing
lamATnginx Mar 13, 2025
445906b
Update with suggestion
lamATnginx Mar 13, 2025
7a1d330
Merge branch 'main' into chore/update-ct
lamATnginx Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CONTRIBUTING_DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{{<call-out "important" "JWT file required for upgrade" "fa fa-exclamation-triangle">}}
{{<call-out "important side-callout" "JWT file required for upgrade" "fa fa-exclamation-triangle">}}
```

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
Expand Down