Icon

Use the jhdocs-icon shortcode to display an icon within your markdown.

This shortcode takes the following parameters:

• icon: Name of the icon to display. See the Icons page for options.
• size: Icon size. One of “x-small”, “small”, “medium”, “large”, or “x-large”. The default is “small”.
• style: Color style. One of “normal”, “information”, “success”, “warning”, or “error”.
• display: Display approach. One of “inline” or “block”. The default is “inline”. Inline elements appear inline within text, while block elements appear on their own line.

Examples

This example renders a medium-sized green checkmark icon. The green color comes from the “success” style.

{{< jhdocs-icon icon="checkmark" size="medium" style="success" >}}

Here is the rendered result of this markdown:

Here are some examples of different icons at different sizes.

Inline vs block display

This is an inline icon. It flows within the text of this sentence.

This is a block icon. It displays on its own line.