Callouts are used to call the user’s attention to a block of information that they really need to see.
A callout displays its content with eye-catching formatting.
Use the jhdocs-calloutshortcode to display a callout.
This shortcode takes the following parameters:
type: The type of styling to display. One of neutral, tip, do, dont, warning, info
icon: Icon to display. Use a value from the icons page or leave this blank to have it set based on the specified type.
title: Callout title. String that specifies the title to display. Leave blank for no title.
Simple example
This first callout example is a simple one. It sets the type and title to “tip”, and provides content. The callout color and
icon are all based on the specified type, which is “tip” in this case.
Simple callout example markdown
{{< jhdocs-callout type="tip" title="Tip" >}}
It's best to save your work often.
{{< /jhdocs-callout >}}
Here is the rendered result of this markdown:
Tip
It’s best to save your work often.
More complex example
The next example is a little more complicated… it sets the type to “warning”, the icon to “camera”, and doesn’t specify a title.
More complex callout example markdown
{{< jhdocs-callout type="warning" icon="camera" >}}
Don't forget to remove the lens cap before snapping that pic.
{{< /jhdocs-callout >}}
Here is the rendered result of this markdown:
Don’t forget to remove the lens cap before snapping that pic.
“Neutral” styling example
'Neutral' styling example markdown
{{< jhdocs-callout type="neutral" title="Checkpoint" >}}
Be sure to read the [Hugo documentation](https://gohugo.io/) before proceeding.
{{< /jhdocs-callout >}}