Zum Inhalt

Setup-Anleitung: Übersicht

Diese Anleitung führt dich Schritt für Schritt durch das komplette Setup deiner MkDocs-Material-Dokumentation auf Cloudflare Pages.

Was bereits erledigt ist

Das Repository enthält bereits alle nötigen Dateien:

  • mkdocs.yml — MkDocs-Konfiguration (Material-Theme, deutsche Suche)
  • docs/index.md — Startseite der Dokumentation
  • .github/workflows/deploy.yml — GitHub-Actions-Workflow (Build + Deploy)
  • renovate.json — automatische Dependency-Updates
  • .gitignore — schließt site/ und .wrangler/ vom Repo aus

Was du jetzt noch tun musst

Schritt Datei Dauer
1. Lokale Vorschau testen 01-lokale-vorschau.md 2 Min
2. Cloudflare Pages-Projekt anlegen 02-cloudflare-pages-projekt.md 5 Min
3. Cloudflare API-Token erstellen 03-api-token.md 3 Min
4. GitHub Secrets hinterlegen 04-github-secrets.md 2 Min
5. Ersten Deploy auslösen 05-erster-deploy.md 3 Min
6. Cloudflare Access einrichten 06-cloudflare-access.md 10 Min
7. Custom Domain (optional) 07-custom-domain.md 5 Min

Gesamtdauer: ca. 30 Minuten.

Hinweis: Navigation / Seitenleiste

Neue .md-Dateien im docs/-Ordner erscheinen automatisch in der Seitenleiste, solange in mkdocs.yml keine explizite nav-Sektion definiert ist. Falls du die Reihenfolge kontrollieren willst, kannst du nav wieder hinzufügen — dann müssen aber alle Seiten dort eingetragen werden, sonst tauchen sie nicht auf.

Komplettanleitung mit All-Inkl-Domain

Falls deine Domain bei All-Inkl registriert ist, findest du eine Schritt-für-Schritt-Anleitung inkl. Nameserver-Umstellung hier: setup-all-inkl-domain.md