On this page

Install#

Sumi is a Python package. It depends on MkDocs NG, so installing Sumi installs MkDocs too.

Requirements#

pip

pip install mkdocs-sumi

uv

uv add --dev mkdocs-sumi

pipx

pipx install mkdocs-ng --include-deps
pipx inject mkdocs-ng mkdocs-sumi

Sumi has two halves: the theme draws the page and the plugin adds the Markdown components, the blog and the extra outputs. Enable both:

mkdocs.yml

theme:
  name: sumi

plugins:
  - search    # powers ⌘K search
  - llms_txt  # optional: llms.txt and a Markdown copy of every page
  - sumi

Important

When you add a plugins: list, MkDocs no longer enables search for you. List it explicitly, as above.

mkdocs serve

Open http://127.0.0.1:8000/. Press ⌘ K (or Ctrl K) to search.

Continue with Your first site, or jump to Writing.