Mkdocs

1. 📂 Ordnerstruktur

/data/mkdocs/
└── daten/
       ├── docs
       |    └── index.md
       └── mkdocs.yml

📄 2. mkdocs.yml – Konfigurationsdatei

weitere Infos zur Konfiguration und zum Layout

Datei erstellen

sudo nano /data/mkdocs/daten/mkdocs.yml

Inhalt:

site_name: Pinguinbox
site_url: https://pinguinbox.de

nav:
  - Startseite: index.md

theme:
  name: material
  language: de
  features:
    - navigation.tabs
    - navigation.top
    - search.suggest
    - content.code.copy

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - footnotes
  - def_list
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

📝 3. index.md – Inhaltsseite

Datei erstellen:

sudo nano /data/mkdocs/daten/docs/index.md

# Willkommen bei Pinguinbox 🐧

Dies ist die Startseite deiner persönlichen Homelab-Dokumentation.

## Erste Schritte

- 🔧 Core-Setup mit Docker und Portainer
- 🌐 Zugriff über Nginx Proxy Manager
- 📘 Erweiterbar mit MkDocs, Nextcloud, SearXNG und mehr

---

> Diese Seite wird mit [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) generiert.

📝 4. Installation

Erstelle die Datei

sudo nano /data/core_config/docker-compose-mkdocs.yml

Inhalt:

version: "3.8"

services:
  mkdocs:
    image: squidfunk/mkdocs-material
    container_name: mkdocs
    restart: unless-stopped
    ports:
      - "8001:8000"
    volumes:
      - /data/mkdocs/daten:/docs
    networks:
      - homelab

networks:
  homelab:
    external: true

Container starten

cd /data/core_config/
sudo docker compose -f docker-compose-mkdocs.yml up -d