mkdocs-void

Glass + NothingOS Design Language for MkDocs

Overview

Void is a custom MkDocs theme that blends the translucent, layered aesthetics of Glass design system with the minimal, industrial clarity of NothingOS. It combines pure black canvas, glass morphism panels, dot-matrix typography, and Nothing Red accents into a cohesive documentation experience.

GitHub Statistics

Live repository metrics for rkriad585/mkdocs-void, mirrored on both GitHub and PyPI.

Screenshot

More screenshots: View all screenshots

Table of Contents

• Key Features
• GitHub Statistics
• Installation
• Quick Start
• Configuration
• Usage Examples
• Documentation
• Interface
• Architecture
• Requirements
• Prerequisites
• Development
• Community
• Acknowledgments

Key Features

Void ships every feature enabled by default — tune behavior with theme.void.* keys, never by editing code.

Visual system

• Glass Morphism — Translucent glass panels with backdrop-filter blur and configurable intensity (light / medium / heavy), plus blur/saturation/opacity token overrides
• NothingOS Canvas — Pure black (#000000) background with monochrome palette and Nothing Red (#ff3030) accents
• Dot-Matrix Overlay — Subtle dot pattern texture inspired by NothingOS (color, size, gap, opacity, position configurable)
• Dark & Light Modes — Toggle between slate (dark) and default (light) color schemes
• Typography — Space Grotesk for display/body, Space Mono for code/labels via Google Fonts (theme.font drives the link AND the body/mono tokens)
• Borders, Shadows, Scrollbar & Selection — Full token groups to re-skin the chrome (border, shadows, scrollbar, selection)
• Animations — Page transitions, hover effects, scroll progressives, reduced-motion aware

Layout & navigation

• Responsive Layout — Glass sidebar, sticky header, TOC rail, and mobile-friendly drawer
• Collapsible Sidebar / TOC — Ctrl+Shift+B and Ctrl+Shift+T, with active tracking and scrollspy
• Breadcrumbs — Auto trail above content when ancestors exist
• SPA navigation — In-page transitions with scroll restore and back/forward handling
• Reading progress + Back-to-Top — Visual scroll indicator and threshold-gated floating button
• Flexible Header & Footer — header: and footer: sections with custom links/buttons, social icons, columns, and default | minimal | extended layouts
• Page-Level Overrides — Front matter void: blocks (hide any region, per-page glass, wide/full layouts, custom CSS)

Content & components

• Table of Contents — Auto-generated TOC with active section tracking
• Full-Screen Search — Instant modal with /, suggestions, highlighting, context snippets, and copy-link results
• Code Blocks — Syntax highlighting with one-click copy, optional line numbers and hl_lines
• Admonitions — Styled note, warning, tip, and danger callouts with per-type colors
• Tabbed Content — Alternating-style tabs for grouped content
• Task Lists — Interactive checkbox lists with persisted state
• Footnotes, Tables, Trees, Toast — Footnote lists, responsive/striped tables, tree code blocks with dimmed comments, and a toast notification system
• Notes & Annotations — Quick side notes with TTL expiry and export (Ctrl+Shift+N)
• Diagrams & Math — Mermaid superfence with zoom/pan/fullscreen, KaTeX math
• Images & SVG — Click-to-zoom lightbox, lazy loading, dark-aware logos

Engagement & privacy

• Page Feedback — "Was this page helpful?" widget that opens a prefilled GitHub issue (no analytics, no tracking)
• Announcement Bar — Dismissable one-line banner (top/right/bottom/left/center), remembered per site
• Privacy-First Cookie Consent — Banner appears only when a real integration is configured; a single accept/decline flag, nothing tracked
• Opt-in Comments (giscus) — Consent-gated comments with palette-synced theme
• "Powered by Void" badge — Footer credit + dot-matrix badge (void_showcase)

Productivity (app layer)

• Reader Mode — Alt+Shift+R distraction-free reading (chrome hidden, article re-measured, persisted)
• Action Cluster — Floating hub (gears/notes/timer/reading) with per-action shortcuts and badges
• Focus Timer — Built-in session timer in the TOC + reading-mode chip, chime + toast on complete
• Repo Popover — Hover the repo link for description, stars, forks, issues, latest commit (cached)
• Keyboard Navigation — Search (/), help (?), close (Esc), and every shortcut remappable
• Reduced Motion Support — Animations disabled when prefers-reduced-motion is active

Developer & extensibility

• Command Shortcuts — Custom rebindings and registered actions in keyboard.custom
• Design Tokens — Override colors, typography, spacing, radius, transitions, shadows under theme.void.*
• Component Toggles — Show/hide any piece via components.*.show (config only)
• Custom CSS/JS/head/body — custom_css, custom_js, extra_*, void_custom_head/body_*, html-attr injection
• Config Builder — Standalone dev tool generating a mkdocs.yml from grouped questions (gear in the cluster, OFF by default)
• AI-Readable Mode — Watermarked Markdown mirrors per page, llms.txt + llms-full.txt for agents
• PWA & Offline — Auto manifest, service-worker caching, CDN/local/bundle asset modes
• Social Cards & JSON-LD — Per-page OG card images and Article structured data
• i18n — Flat alias strings for search/TOC/labels
• SCSS Build Pipeline — Sass compilation with PostCSS autoprefixer and cssnano minification

Installation

pip install mkdocs-void

This installs both the Void theme and the companion MkDocs plugin automatically.

Quick Start

1. Install the package:

   pip install mkdocs-void
   

2. Scaffold a new project with Void's CLI — it pre-enables the theme and the void plugin:

   void new my-docs
   cd my-docs
   

3. Start the dev server:

   mkdocs serve
   

4. Open http://127.0.0.1:8000 in your browser.

Configuration

Minimal

theme:
  name: void

Full

theme:
  name: void
  favicon: assets/images/favicon.svg
  language: en
  palette:
    - scheme: slate
      primary: black
      accent: red
      toggle:
        name: Switch to light mode
    - scheme: default
      primary: white
      accent: red
      toggle:
        name: Switch to dark mode
  font:
    text: Space Grotesk
    code: Space Mono
  features:            # Material-compatible passthrough (always-on, no gating)
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.code.copy
    - search.suggest
    - search.highlight
  void:
    glass: medium
    dot_matrix: true
    animation: normal
    border: thin

plugins:
  - search
  - void

Theme Options

Usage Examples

Admonitions

!!! note "Glass Note"
    This is a styled admonition with the Void design.

!!! warning "Accent Warning"
    This uses the Nothing Red accent color.

!!! tip "Pro Tip"
    Glass effects adapt to your color scheme choice.

Code Blocks

```python
def hello():
    print("Hello from Void")
```

Tabs

=== "Python"

    ```python
    pip install mkdocs-void
    ```

=== "Node.js"

    Not applicable — Void is a Python package.

Task Lists

- [x] Install Void
- [x] Configure mkdocs.yml
- [ ] Deploy documentation

Documentation

Interface

Void is a MkDocs theme — it provides HTML templates, CSS, and JavaScript that render your Markdown documentation as a styled website.

Header

• Logo and site name (left)
• Hamburger menu toggle (mobile)
• Dark/light mode toggle
• Search button
• Repository link

Sidebar

• Collapsible navigation tree with section grouping
• Active page highlighting
• Toggle buttons for expanding/collapsing sections

Content

• Markdown content with typeset typography
• Code blocks with syntax highlighting and copy button
• Admonitions, tabs, tables, task lists
• Table of contents (right side on wide screens)

Keyboard Shortcuts

Architecture

mkdocs-void/
├── void/                          # Python package
│   ├── __init__.py                  # Version (0.2.2)
│   ├── plugins/
│   │   └── void_plugin.py         # MkDocs plugin (theme defaults)
│   ├── templates/
│   │   ├── base.html                # Root HTML template
│   │   ├── main.html                # Content wrapper
│   │   ├── 404.html                 # Error page
│   │   ├── mkdocs_theme.yml         # Theme registration
│   │   ├── partials/
│   │   │   ├── header.html          # Sticky header
│   │   │   ├── nav.html             # Sidebar navigation
│   │   │   ├── content.html         # Content renderer
│   │   │   ├── toc.html             # Table of contents
│   │   │   ├── footer.html          # Prev/next + copyright
│   │   │   ├── palette.html         # Dark/light toggle
│   │   │   ├── search.html          # Search modal
│   │   │   ├── progress.html        # Reading progress bar
│   │   │   └── javascripts/
│   │   │       └── palette.html     # FOUC prevention script
│   │   └── assets/
│   │       ├── void.css           # Compiled CSS
│   │       ├── stylesheets/
│   │       │   ├── void.scss      # Design tokens + base
│   │       │   └── components.scss  # Component styles
│   │       ├── javascripts/
│   │       │   └── void.js        # Theme JS (vanilla ES6+)
│   │       └── images/
│   │           ├── logo.svg         # Theme logo
│   │           └── favicon.svg      # Browser favicon
│   ├── extensions/                  # Reserved for future use
│   └── utilities/                   # Reserved for future use
├── docs/                            # Documentation source
├── logo/
│   └── logo.svg                     # Project logo (512x512)
├── tools/
│   ├── build.js                     # SCSS build pipeline
│   └── screenshots_gen.py           # Screenshot generator
├── Screenshots/                     # Generated screenshots
├── mkdocs.yml                       # MkDocs configuration
├── pyproject.toml                   # Python package config
├── package.json                     # Node.js dependencies
└── requirements.txt                 # Python dependencies

Data Flow

graph TD
    A[Markdown Files] --> B[MkDocs]
    B --> C[void_plugin.py]
    C --> D[HTML Templates]
    D --> E[base.html]
    E --> F[partials/header.html]
    E --> G[partials/nav.html]
    E --> H[partials/content.html]
    E --> I[partials/toc.html]
    E --> J[partials/footer.html]
    E --> K[partials/search.html]
    E --> L[assets/void.css]
    E --> M[assets/javascripts/void.js]
    N[void.scss] --> O[tools/build.js]
    O --> P[void.css]

CSS Architecture

The stylesheet is organized in layers:

1. Design Tokens (void.scss :root) — CSS custom properties for colors, spacing, typography, glass, shadows, z-index, animations
2. Light Mode Overrides ([data-md-color-scheme="default"]) — Token overrides for light theme
3. Glass Intensity Variants — Light/medium/heavy glass via data-md-void-glass attribute
4. Base Resets — Box-sizing, font smoothing, reduced motion
5. Dot Matrix Overlay — Radial gradient pattern
6. Glass Components — .void-glass, .void-card
7. Typography — Display, labels, body, code
8. Components (components.scss) — Layout, header, nav, content, TOC, footer, search, tabs, admonitions, code blocks, tables, and more

Requirements

• Python 3.8 or higher
• MkDocs 1.5 or higher
• Node.js 18 or higher (for building CSS)
• A modern browser with support for backdrop-filter

Prerequisites

• pip (Python package manager)
• npm (Node.js package manager)
• A text editor or IDE

Development

Clone and Install

git clone https://github.com/rkriad585/mkdocs-void.git
cd mkdocs-void
pip install -e .
npm install

Build CSS

npm run build

Watch Mode

npm run start

Dev Mode

npm run dev

Serve Documentation

mkdocs serve

Docs Health

• The documentation (docs/**) and every README in this repository never link to, embed, or depend on planning artifacts. They stand on their own and link only user-facing pages.
• The config reference is generated, not hand-written: python tools/emit_config_reference.py → docs/_config_ref.generated.md (snippets-included into the Configuration page).

Lint

ruff check void/

Clean

rm -rf site/ dist/ build/ *.egg-info .ruff_cache/
find . -type d -name __pycache__ -exec rm -rf {} +

Or use Make:

make install    # Install dependencies
make build      # Build CSS
make dev        # Dev mode
make serve      # Serve docs
make lint       # Run linter
make clean      # Remove build artifacts
make help       # Show all commands

Community

• Discussions — ask questions and share showsites at github.com/rkriad585/mkdocs-void/discussions
• Good first issues — browse issues labeled good first issue to start contributing
• Translations — see the Translating Void guide
• Sponsor — fund development via GitHub Sponsors or Open Collective

Acknowledgments

• MkDocs — the static site generator this theme is built for
• Space Grotesk and Space Mono — the typefaces used throughout the theme
• Nothing Technology — for the NothingOS design identity