Wiki bearbeiten¶

Dieses Wiki basiert auf MkDocs Material und wird über GitHub Pages bereitgestellt. Alle Inhalte sind einfache Markdown-Dateien im docs/-Ordner.

Direkt auf GitHub bearbeiten¶

Klicke auf den Bearbeiten-Button oben rechts auf einer Wiki-Seite
Du wirst zur entsprechenden Datei auf GitHub weitergeleitet
Nimm deine Änderungen vor
Klicke auf "Propose changes" — das erstellt automatisch einen Pull Request
Nach dem Review wird die Änderung übernommen und das Wiki aktualisiert sich automatisch

Lokal bearbeiten¶

Falls du größere Änderungen machen möchtest:

# Repository klonen
git clone https://github.com/EmergencyForge/Wiki.git
cd Wiki

# Python-Abhängigkeiten installieren
pip install -r requirements.txt

# Lokalen Dev-Server starten
mkdocs serve

Das Wiki ist dann unter http://localhost:8000 erreichbar und aktualisiert sich bei Änderungen automatisch.

Neue Seite anlegen¶

Erstelle eine neue .md-Datei im passenden Unterordner von docs/

Füge am Anfang der Datei einen Titel und Tags hinzu:

---
title: Mein neuer Artikel
tags:
  - Neu
---

# Mein neuer Artikel

Hier kommt der Inhalt...

Trage die Seite in der mkdocs.yml unter nav: ein

Nützliche Formatierung¶

MkDocs Material unterstützt viele nützliche Extras:

Hinweisboxen¶

!!! info "Titel"
    Hier steht eine Information.

!!! warning "Achtung"
    Hier steht eine Warnung.

!!! tip "Tipp"
    Hier steht ein nützlicher Tipp.

Code-Blöcke¶

```python
print("Hello EmergencyForge!")
```

Tabellen¶

| Spalte 1 | Spalte 2 |
|----------|----------|
| Wert A   | Wert B   |