Callouts

What's in a name?

I call them callouts, MkDocs all them admonitions.

Either way, they are ways to to draw attention to some content. Unfortunately, I have not been real consistent in my use of these across the IBM Cloud L3s, and we don't have a "standard". I think this is something we will try to address in future as we work across other teams doing similar L3s with markdown.

Read this before continuing!

Did it work? Sometimes it seems strange as the font may be smaller, but it does make the text more pronounced. The problem is many users still won't read it, but hey we gotta try.

You can also make it where only the "headline" shows and the user has to expand to see the body, like this:

Read this before continuing!

Did it work? Sometimes it seems strange as the font may be smaller, but it does make the text more pronounced. The problem is many users still won't read it, but hey we gotta try.

There are other icons instead of what shows for "Important" ones. I often use "Note", "Info", and "Warning". You can find more in the MkDocs documentation here.

Links were mentioned in the previous chapter. You an also create links to internal pages like this: Go to Part 2 - 01 Tables.