On this page
Sumi documentation#
Sumi is a documentation theme for MkDocs. It turns a folder of plain Markdown into a complete, searchable, printable website — with a home page, a blog and release notes — without Node.js, a CDN or a hosted service.
- Install Add Sumi to an existing MkDocs project in two lines of configuration.
- Write Sixteen components, all written in native Markdown.
- Pages Landing pages, a blog, release downloads and a print edition.
- Customize Colours, navigation, search, languages, versions and template overrides.
What you get#
| Area | Included |
|---|---|
| Reading | Top tabs, collapsible sidebar, breadcrumbs, table of contents with scroll spy, previous / next |
| Discovery | Local full-text search with CJK support, merged with a command palette (⌘ K) |
| Authoring | Callouts, tabs, steps, cards, fields, captions, galleries, badges, file trees, Mermaid, ECharts, mind maps, KaTeX, keys, 1 900+ icons |
| Pages | Data-driven landing page, blog with tags and Atom feed, releases with checksums, whole-site print edition |
| Outputs | HTML, print, a Markdown copy of every page, llms.txt, Atom |
| Operations | Dark mode, mike versions, language switcher, edit links, Git "last updated" dates, analytics |
Principles#
Sumi follows four rules. They are explained in Design principles.
- Content stays Markdown. A component is a blockquote, a list, a table or a fence with one attribute line.
- Everything is local. Every font, icon and script is part of your built site.
- Pay only for what you use. Diagrams and formulas load their runtime on the pages that contain them.
- People and agents are both readers. Every page is published as HTML and as Markdown.