Skip to content
New to Sumi? Read the introduction.
Sumi

Releases#

Install the latest release from PyPI:

pip install --upgrade mkdocs-sumi

Sumi follows semantic versioning. Until 1.0, minor versions may change template blocks; configuration keys and Markdown syntax stay compatible.

0.1.2

Latest

Landing page links to Markdown files now lead to the built pages.

  • A landing page link: guide.md in front matter now points at the page built from guide.md, not at its Markdown copy. Like a Markdown link, it is relative to the landing page and keeps its #anchor, and the build warns when the file doesn't exist.

0.1.1

API reference styling and layout fixes, found by moving the MkDocs-ng site to Sumi.

  • Style mkdocstrings API pages: signatures, symbol badges, labels and nested members.
  • Centre pages that have a table of contents but no sidebar, such as top-level pages and blog posts.
  • Drop the second rule when a page puts --- right before a heading.
  • New logo_dark theme option: a second header logo for the dark palette.
  • git_dates no longer fails on Python 3.10 when Git writes a UTC commit date as Z.

0.1.0

The first public release.

  • Theme with header tabs, sidebar, table of contents, breadcrumbs and pager.
  • Twelve native-Markdown components: callouts, tabs, steps, cards, fields, captions, file trees, Mermaid, KaTeX, keys and icons.
  • Command palette with local, CJK-aware search.
  • Landing, blog, releases and print page types.
  • Markdown copy of every page, llms.txt discovery links, Copy as Markdown.
  • English, Simplified Chinese and Traditional Chinese interface.
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