Expand/Collapse
The Table of Contents above is wrapped in an expand/collapse shortcode. Use it on any page to hide long sections or reveal extra details on demand.
Example 1 : Collapsed section with a title
{{< expand title="Click to reveal more" >}}
... markdown content to be displayed
{{< /expand >}}Example 2: Expanded section with default title
{{< expand open="true" >}}
... already expanded content
{{< /expand >}}Icon
Insert icons inline within markdown content using the icon shortcode.
Example 1: Inserting an icon
Here is a star icon: {{< icon name="star" style="regular" >}}Here is a star icon:
Example 2: Icon with different size
Here is same star icon but filled : {{< icon name="star" style="solid" >}}Here is same star icon but filled :
Icons are fetched from Font Awesome free catalog. Check below links for supported icons in each style:
Badge
Display colorful marker badges inline with your text to highlight important information, versions, statuses, or any other metadata.
Example 1: Simple badge (avoid using it without proper styling)
{{% badge %}}Important{{% /badge %}}Example 2: Badge with style
{{% badge style="info" %}}New{{% /badge %}}
{{% badge style="note" %}}Note{{% /badge %}}
{{% badge style="tip" %}}Optional{{% /badge %}}
{{% badge style="warning" %}}Breaking{{% /badge %}}
{{% badge style="important" %}}Caveat{{% /badge %}}
{{% badge style="caution" %}}Don'ts{{% /badge %}}InfoNew NoteNote TipOptional WarningBreaking ImportantCaveat CautionDon’ts
Example 3: Badge with custom title, color and icon
{{% badge color="#007bff" textColor="#fff" title="Version" %}}6.6.6{{% /badge %}}
{{% badge color="#dc3545" textColor="#fbff00" icon="angle-double-up" title="Rank" %}}Captain{{% /badge %}}Version6.6.6 RankCaptain
Example 4: Badge inline with text
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit,
sed quia consequuntur magni dolores eos qui ratione voluptatem sequi
nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet,
{{% badge color="#6ab0de" textColor="#000" icon="rocket" %}}Awesome{{% /badge %}}
consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt
ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima
veniam, quis nostrum exercitationem ullam corporis suscipit.Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, Awesome consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit.
To remove the default icon or title from a severity style (
info,note,tip,warning,important,error), set the parameter to" "(a space).