On this page

Keys and icons#

Keyboard shortcuts#

Wrap a key combination in double plus signs:

Press ++Ctrl+Shift+P++ to open the command palette, or ++Esc++ to close it.

Press Ctrl+Shift+P to open the command palette, or Esc to close it.

For a single key in running text, plain <kbd> also works: Enter.

Icons#

Write :lucide-name: to insert any of the 2 000 Lucide icons, or :brand-name: for a brand logo. Icons are inlined as SVG at build time and take the colour of the surrounding text.

:lucide-rocket: Launch · :lucide-shield-check: Secure · :lucide-languages: Translated

Launch · Secure · Translated

Unknown names are left as text, so a typo is easy to spot.

Brand icons#

Icon	Name	Icon	Name
	`brand-github`		`brand-gitlab`
	`brand-gitee`		`brand-codeberg`
	`brand-python`		`brand-pypi`
	`brand-docker`		`brand-rust`
	`brand-x`		`brand-mastodon`
	`brand-bluesky`		`brand-discord`
	`brand-wechat`		`brand-zhihu`
	`brand-bilibili`		`brand-xiaohongshu`
	`brand-youtube`		`brand-rss`

The full set also includes bitbucket, telegram, reddit, stackoverflow, npm, go, postgresql, markdown, readthedocs, matrix, qq, medium, devdotto, substack, facebook and instagram.

In templates and front matter#

The same names are used everywhere Sumi accepts an icon: landing page features, buttons, social links and cards.

extra:
  social:
    - icon: brand-github
      link: https://github.com/mkdocs-ng/mkdocs-sumi