Banner

A banner shows a short announcement that applies to the whole page: to the documentation version, a validity period or an important change. For a note next to a specific step choose an alert.

Example

:::banner {type=info}
This version of the documentation applies to the current stable build.
:::

Markup

:::banner {type=warning}
One or two sentences: what changed and what to do.
:::

• Inside is plain Markdown, without a heading. A banner without text stops the build.
• Put the banner at the start of the page, before the main text.

The banner is built on the SIMAI Framework alert (sf-alert) in its flat look.

Variants

Type

type sets the meaning of the announcement: the colour and the icon depend on it.

:::banner {type=info}
This version of the documentation applies to the current stable build.
:::

:::banner {type=success}
The documentation is updated to the current stable version.
:::

:::banner {type=warning}
Save the current build before updating.
:::

:::banner {type=danger}
This version no longer receives security fixes.
:::

Accessibility

• A banner is a status region: screen readers announce it as a separate message.
• The icon and the text carry the meaning, not only the colour. Name the consequence or the next action in words.
• One banner per page: readers skip several announcements in a row.

Parameters

See also

• Alert — a note next to the text
• Button link — a move to the next action
• Landing blocks — a call to action on a landing page