Skip to content
New to Sumi? Read the introduction.
Sumi
On this page

Badges#

Put {.badge} right after bold or italic text to turn it into a badge. This is the standard attr_list syntax, so a renderer that does not know Sumi still shows the word in bold.

## Command palette **New**{.badge .new}

| Option | Status |
| --- | --- |
| `palette` | **Stable**{.badge .tip} |
| `brand` | **Beta**{.badge .warning} |
| `legacy_nav` | **Deprecated**{.badge .deprecated} |
Option Status
palette Stable
brand Beta
legacy_nav Deprecated

Tones#

A second class picks the colour. Without one, a badge is neutral grey.

Class Badge
(none) Default
.note, .info Note
.tip, .success Stable
.important, .new New
.warning Beta
.caution, .danger, .deprecated Removed
.accent Sumi

In headings#

A badge in a heading shrinks to fit, and stays out of the table of contents text.

Version 0.2 Latest#

## Version 0.2 **Latest**{.badge .tip}
Esc
↵ to open ↑↓ to move Esc to close
Keyboard shortcuts
Ctrl K /
Open search and commands
t
Toggle dark mode
[ ]
Previous / next page
j k
Previous / next heading
?
Show this help