Skip to content

Add mkdocs-zen-mode plugin#391

Open
nitaibezerra wants to merge 1 commit intomkdocs:mainfrom
nitaibezerra:add-mkdocs-zen-mode
Open

Add mkdocs-zen-mode plugin#391
nitaibezerra wants to merge 1 commit intomkdocs:mainfrom
nitaibezerra:add-mkdocs-zen-mode

Conversation

@nitaibezerra
Copy link

New Project

Description

Zen Mode toggle for MkDocs Material — distraction-free reading. Adds a toggle button to the header that hides navigation, TOC, header, footer, and tabs with a single click or keyboard shortcut (Alt+Z). State persists via localStorage across pages and sessions.

Features

  • Toggle button in header (next to search)
  • Configurable: choose which elements to hide
  • Keyboard shortcut (Alt+Z, configurable)
  • localStorage persistence
  • Works with navigation.instant (SPA mode)
  • Smooth CSS transitions
  • Floating exit button
  • Dark mode compatible
  • 68 tests (unit + integration + Playwright E2E)

Installation

pip install mkdocs-zen-mode
plugins:
  - zen-mode

Zen Mode toggle for MkDocs Material — distraction-free reading.
Hides navigation, TOC, header, footer, and tabs with a single
click or Alt+Z keyboard shortcut. State persists via localStorage.

- PyPI: https://pypi.org/project/mkdocs-zen-mode/
- GitHub: https://github.com/nitaibezerra/mkdocs-zen-mode
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant