Getting Started¶

This section covers installation, setup, and configuration of the Void theme.

Installation¶

Install the theme from PyPI:

pip install mkdocs-void

This installs both the theme and the companion MkDocs plugin.

Quick Setup¶

1. Create a new MkDocs project:

mkdocs new my-docs
cd my-docs

1. Set the theme in mkdocs.yml:

site_name: My Docs
theme:
  name: void

1. Start the dev server:

mkdocs serve

1. Open http://127.0.0.1:8000.

Next Steps¶

• Configuration — Customize the theme to your liking
• Design System — Learn how the design works under the hood
• Components — Explore available UI components

Back to README