Last updated
Was this helpful?
Last updated
Was this helpful?
Hints are a great way to bring the reader’s attention to specific elements in your documentation, such as tips, warnings, and other important information.
There are four different hint styles — you can change the style by clicking the colored icon, or by opening the block’s Options menu and selecting the style you want.
Hint blocks support and , as well some specific block types. To see which block types you can use in a hint, hit / on an empty line and check the .
Success hints are good for showing positive actions or achievements.
Warning hints are good for showing important information or non-critical warnings.
Danger hints are good for highlighting destructive actions or raising attention to critical information.
This is a line
This is an inline image
This is a second line using an unordered list and color
To add a heading to your hint, you need to create a heading block as the the first block in the hint.
Add a hint to a page to draw your reader’s attention to specific pieces of important information
