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

Cards#

A bullet list of links followed by {.cards} becomes a grid. The link is the card title; the text after it is the description; an inline icon at the start becomes the card icon.

- :lucide-rocket: [Install](../start/install.md)
  Add Sumi to a project.
- :lucide-pen-line: [Write](index.md)
  Components in plain Markdown.
- :lucide-palette: [Customize](../customize/theme.md)
  Colours, fonts and layout.
{.cards}
  • Install Add Sumi to a project.
  • Write Components in plain Markdown.
  • Customize Colours, fonts and layout.

Columns#

Cards fill as many columns as fit, up to three. Set cols to fix the number:

{.cards cols=2}
  • Source code Report a bug or send a pull request.
  • PyPI Release history and downloads.

Items without a link render as static cards — useful for a list of features:

  • Local-first Every asset ships with your site.
  • Fast No framework; one small script.
  • Printable A whole-site print edition.
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