On this page
Badges
Badges are small labels in a line of text or a heading: what is new, in beta or on its way out.
The `--strict` option :badge[Since 2.0]{tip} fails builds with warnings.The --strict option Since 2.0 fails builds with warnings.
#Types
Write the badge’s text in square brackets, and its type in braces. The types are named like the alerts:
| Write | Shows |
|---|---|
:badge[New] |
New |
:badge[Info]{info} |
Info |
:badge[Note]{note} |
Note |
:badge[Stable]{tip} |
Stable |
:badge[Beta]{important} |
Beta |
:badge[Deprecated]{warning} |
Deprecated |
:badge[Removed]{caution} |
Removed |
:badge[Unsafe]{danger} |
Unsafe |
A type Clay does not know shows like a badge without a type.
#In headings
### clay edit :badge[Since 3.0]{tip}A badge in a heading is part of the heading’s text, also for its # link: the heading above is linked as #clay-edit-since-30. Put the badge in when you write the heading, so links to it do not change later.
Tip
One badge says a lot; a page full of them says nothing. Use them for what readers must not miss.