Skip to content

chore(docs): bump mkdocs-sumi to 0.4.1 and drop its workarounds - #94

Merged
shenxianpeng merged 3 commits into
mainfrom
chore/bump-sumi-0.4.1
Nov 19, 2026
Merged

shenxianpeng merged 3 commits into
mainfrom
chore/bump-sumi-0.4.1

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 19, 2026 •

Copy link
Copy Markdown
Member

Sumi 0.4.1 fixes the three theme problems that #92 worked around on the site side. This bumps the theme and removes those workarounds.

Sumi 0.3.1 problem Workaround in #92 Now
Inline code in tables broke mid-word (overflow-wrap: anywhere) td code, th code { overflow-wrap: break-word } in extra.css removed; Sumi does it
Code blocks drew != as ≠ (the font shorthand reset ligatures) ligature rule for .sumi-prose pre in extra.css removed; Sumi does it
No phone menu on a landing page without navigation tabs hand-made <aside> drawer in landing.html, layout: docs in index.md, a hide rule in landing.css landing.html includes Sumi's partials/sidebar.html, which 0.4.1 renders as a drawer only; index.md keeps Sumi's landing layout

One small addition: with the landing layout, Sumi narrows the header and footer to 1200px. landing.css keeps them at the 1220px column the page already uses, so the home page looks the same as before.

Before vs after

  • Home page at 1440px, full page: pixel-identical to the live site (screenshots compared with reduced motion so the demo animation holds still).
  • Home page at 390px: same as the live site apart from text antialiasing. The menu button shows, and the drawer slides in with the full navigation:

Home page on a phone with the navigation drawer open

  • Mid-word breaks in table code on all 31 pages: 0 at 1280px and 0 at 390px, the same as with the workaround.
  • Code block on the Configuration page: computed font-variant-ligatures: none.
  • At 1440px the drawer is hidden and the menu button is not shown. No page scrolls sideways.

Checks

  • mkdocs build --strict passes.
  • pytest tests passes (18).

Summary by CodeRabbit

  • Documentation
    • Updated the landing page navigation to use a phone-drawer sidebar.
  • Style
    • Adjusted landing-page header and footer content to align with the page width and spacing.
    • Removed custom code-block ligature and inline-code wrapping rules.

Sumi 0.4.1 keeps inline code in tables from breaking mid-word, turns
ligatures off in code blocks, and gives a landing page a phone menu, so
the CSS and the hand-made drawer added for 0.3.1 are no longer needed.
The landing page now keeps Sumi's landing layout; its header and footer
stay aligned to the 1220px column.
@netlify

netlify Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit bdde594
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6afee375199ee4ed26396004
😎 Deploy Preview https://deploy-preview-94--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@shenxianpeng shenxianpeng added the documentation Improvements or additions to documentation label Nov 19, 2026 — with Claude
@shenxianpeng shenxianpeng self-assigned this Nov 19, 2026
@coderabbitai

coderabbitai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation updates the Sumi version, landing-page sidebar integration, and related layout styles. It also removes CSS rules for code formatting and clears the docs layout setting from the index page.

Changes: Documentation theme updates

Layer / File(s) Summary
Sumi dependency and landing navigation
docs/requirements.txt, docs/index.md, docs/overrides/landing.html
The Sumi dependency pin changes from 0.3.1 to 0.4.1. The landing template includes Sumi’s sidebar partial, and the index page no longer sets layout: docs.
Landing-page style updates
docs/stylesheets/landing.css, docs/assets/extra.css
At widths of at least 921px, the landing stylesheet sets the header, footer, and footer links to the landing-page width with 20px inline padding. It removes the drawer visibility rule and the two code-formatting rules.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

Suggested labels: documentation

Merge Risk: Minimal · up to bdde5

This documentation theme update drops the workaround CSS and custom drawer in favor of the theme's own behavior. It affects only the docs site, is easy to revert, and shows no merge-blocking risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title names the main change: bumping mkdocs-sumi from 0.3.1 to 0.4.1 in docs/requirements.txt. It also names the removal of workarounds, which matches the CSS removals in docs/stylesheets/landing.…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Full details: Title check

Explanation

The title names the main change: bumping mkdocs-sumi from 0.3.1 to 0.4.1 in docs/requirements.txt. It also names the removal of workarounds, which matches the CSS removals in docs/stylesheets/landing.css and docs/assets/extra.css, the landing.html sidebar include, and the removed layout comment in docs/index.md. The title is specific and matches the changeset.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ad188ad0-a629-4428-b9e4-26ab66f38910
Commits

Reviewing files that changed from the base of the PR and between cbd08d9 and bdde594.

Files selected for processing: 5

  • docs/assets/extra.css
  • docs/index.md
  • docs/overrides/landing.html
  • docs/requirements.txt
  • docs/stylesheets/landing.css
Files with no reviewable changes: 2

  • docs/assets/extra.css
  • docs/index.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@shenxianpeng
shenxianpeng merged commit 0325250 into main Nov 19, 2026
8 checks passed
@shenxianpeng
shenxianpeng deleted the chore/bump-sumi-0.4.1 branch November 19, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant