Homelab

Documentation for my personal homelab.

Built with MkDocs and Material for MkDocs.

Run locally

Create a virtual environment:

python -m venv .venv

Activate it:

Windows PowerShell

.\.venv\Scripts\Activate.ps1

macOS / Linux

source .venv/bin/activate

Install dependencies:

pip install -r requirements.txt

Start the local documentation server:

mkdocs serve

Open:

http://127.0.0.1:8000

Build the site

mkdocs build

The generated website will be placed in:

site/

mkdocs gh-deploy

Update `site_url` in `mkdocs.yml` with your GitHub Pages URL before deployment.