markdown-alerts.md

Attention Grabbers

There are instances where you want to emphasize some points in your documentation but bold and italics are just not enough.

QuickieDox comes with inbuilt helper css classes that turn block elements in your documentation to highlighted sections that grab the attention of your readers. We call these alerts. There are four types of alerts classes. Note, Tip, Okay and Stop. The difference between the various types of alerts is the colour of the element and the icon used.

Note

{.alert.note} This is an example of a note alert. In here we use the info icon and have a yellow background colour.

Below is the markdown used in generating the above alert.

{.alert.note}
This is an example of a note alert. 
In here we use the info icon and have a yellow background colour.

Tip

{.alert.tip} This is an example of a tip alert. In here we use the bulb icon and have a blue background colour.

Below is the markdown used in generating the above alert.

{.alert.tip}
This is an example of a tip alert. 
In here we use the bulb icon and have a blue background colour.

Okay

{.alert.okay} This is an example of an okay alert. In here we use the check icon and have a green background colour.

Below is the markdown used in generating the above alert.

{.alert.check}
This is an example of an okay alert. 
In here we use the check icon and have a green background colour.

Stop

{.alert.stop} This is an example of a stop alert. In here we use the exclamation icon and have a red background colour.

Below is the markdown used in generating the above alert.

{.alert.stop}
This is an example of an okay alert. 
In here we use the exclamation icon and have a red background colour.