<!-- Generated by Void for AI agents. -->
<!-- Site: Void Documentation -->
<!-- URL: https://rkriad585.github.io/mkdocs-void/index.md -->
<!-- Generated: 2026-09-10T14:47:04Z -->
<!-- Version: 0.2.0 -->

<p align="center">
  <img src="https://github.com/rkriad585/mkdocs-void/raw/main/docs/assets/images/logo.svg" alt="Void Logo" height="120"
       data-md-scheme-dark="https://github.com/rkriad585/mkdocs-void/raw/main/docs/assets/images/logo.svg"
       data-md-scheme-light="https://github.com/rkriad585/mkdocs-void/raw/main/docs/assets/images/logo-light.svg">
</p>

<h1 align="center">Welcome to Void</h1>

<p align="center">
  <strong>Glass + NothingOS Design Language for MkDocs</strong>
</p>

---

Void combines the translucent depth of Glass with the industrial minimalism of NothingOS to create a unique documentation experience.

## Design Principles

### Glass

- Translucent glass panels with `backdrop-filter` blur
- Dynamic transparency that adapts to content
- Smooth, fluid animations and transitions
- Depth through layering and glass effects

### NothingOS

- Pure black canvas as primary background
- Monochrome palette with accent signals
- Dot-matrix inspired typography
- Industrial, raw aesthetic

## Features

- **Glass Morphism** — Beautiful frosted glass effects with configurable intensity
- **Dark/Light Modes** — Toggle between slate and default color schemes
- **Dot Matrix Overlay** — Subtle dot pattern for texture
- **Responsive Design** — Works on all screen sizes
- **Keyboard Navigation** — Full keyboard support with shortcuts
- **Search** — Instant search with keyboard shortcut (`/`)
- **Reading Progress** — Visual scroll indicator
- **Code Copy** — One-click copy for code blocks

## Quick Start

```bash
pip install mkdocs-void
```

```yaml
# mkdocs.yml
theme:
  name: void
```

```bash
mkdocs serve
```

## Example

!!! note "Glass Note"
    This is a glass-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.

---

*Void — Where glass meets minimalism.*

[About](https://github.com/rkriad585/mkdocs-void/blob/main/docs/about.md) · [GitHub](https://github.com/rkriad585/mkdocs-void) · [Report an Issue](https://github.com/rkriad585/mkdocs-void/issues)


<!-- End of markdown mirror. -->
