On this page

Plugin options#

The sumi plugin adds the Markdown components, the blog, the print edition, the Markdown copy button and Git dates. The theme needs it; you can use it without options.

mkdocs.yml

plugins:
  - search
  - llms_txt
  - sumi:
      git_dates: true
      assistant_links: [claude, chatgpt]

Options#

languagestringDefault theme.locale

Language of default callout titles and generated text.

mathbooleanDefault true

Parse $…$ and $$…$$ and load KaTeX on pages that use them.

mermaidbooleanDefault true

Render mermaid fences and load Mermaid on pages that use them.

echartsbooleanDefault true

Render echarts fences (YAML or JSON options) as charts. See Charts.

markmapbooleanDefault true

Render markmap fences (Markdown outlines) as mind maps. See Mind maps.

markdown_copybooleanDefault true

Show Copy as Markdown and View as Markdown when a Markdown copy of the page exists.

assistant_linkslistDefault []

Add "Open in Claude" or "Open in ChatGPT" to the page menu: claude, chatgpt. Off by default, because they send the page address to a third party.

git_datesbooleanDefault false

Show "Last updated" from the last Git commit that touched each page. One git log runs per build.

blog.enabledbooleanDefault true

Treat files under blog.dir as posts.

blog.dirstringDefault blog

The blog folder under docs/.

blog.feedbooleanDefault true

Write an Atom feed to blog/feed.xml.

blog.feed_itemsintegerDefault 20

Number of posts in the feed.

blog.authorsmappingDefault {}

Authors, if you prefer not to use .authors.yml.

print.enabledbooleanDefault true

Write the print edition.

print.pathstringDefault print/

Where to write it.

Markdown extensions#

The plugin enables a small set of Python-Markdown extensions that the components rely on. They are listed in Writing. Your own markdown_extensions entries take precedence: if you configure one of them with options, your options are used.

Git dates in CI#

Shallow clones only contain the last commit, which makes every page look updated today. Fetch the full history before building:

.github/workflows/docs.yml

- uses: actions/checkout@v5
  with:
    fetch-depth: 0