---

# cheatsheets

---

🧭 Schritt-für-Schritt: Zensical Setup (inkl. venv)

---

1. Projektordner erstellen

mkdir my-docs
cd my-docs

---

2. Virtuelle Umgebung erstellen

python -m venv venv

Aktivieren:

• Linux / macOS / Code-Server:

source venv/bin/activate

• Windows:

venv\Scripts\activate

👉 Danach sollte (venv) im Terminal stehen.

---

3️⃣ pip aktualisieren

python -m pip install --upgrade pip

---

4. Zensical installieren

pip install zensical

Optional prüfen:

zensical --help

---

5. Neues Zensical-Projekt erstellen

zensical new .

👉 Dadurch entsteht:

.
├─ .github/
├─ docs/
│  ├─ index.md
│  └─ markdown.md
└─ zensical.toml

---

6. Projekt starten (Live-Vorschau)

zensical serve

👉 Dann im Browser öffnen:

http://127.0.0.1:8000

💡 Wenn du im Code-Server bist und Port-Probleme hast:

zensical serve --host 0.0.0.0 --port 8080

---

7. Inhalte bearbeiten

• docs/index.md → Startseite
• docs/markdown.md → weitere Inhalte

Beispiel:

# Hallo Welt

Das ist meine Zensical-Doku 🎉

---

8. Build für Deployment

zensical build

👉 Ergebnis im Ordner:

site/

Diesen kannst du hochladen zu:

• GitHub Pages
• Netlify
• Vercel

---

9. Abhängigkeiten speichern (empfohlen)

pip freeze > requirements.txt

---

venv wieder deaktivieren

deactivate

---

⚠️ Typische Fehler & Tipps

• ❌ venv vergessen zu aktivieren → Pakete landen global
• ❌ zensical new . in falschem Ordner → Chaos 😅
• ❌ Port blockiert → anderen Port nutzen

---

✅ Kurz-Zusammenfassung

1. Ordner erstellen
2. venv erstellen & aktivieren
3. pip install zensical
4. zensical new .
5. zensical serve
6. Markdown bearbeiten
7. zensical build für Deployment

---

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.