Styleguide & Formatierung

Diese Seite zeigt alle Formatierungsmöglichkeiten, die im EmergencyForge Wiki zur Verfügung stehen. Nutze sie als Referenz beim Schreiben neuer Inhalte.

---

Text-Formatierung

Syntax	Ergebnis
**Fett**	Fett
*Kursiv*	Kursiv
***Fett & Kursiv***	Fett & Kursiv
~~Durchgestrichen~~	~~Durchgestrichen~~
==Hervorgehoben==	Hervorgehoben
`Code`	Code
[Link](https://example.com)	Link

---

Überschriften

# Überschrift 1
## Überschrift 2
### Überschrift 3
#### Überschrift 4

Tipp

Verwende pro Seite nur eine #-Überschrift (H1). Unterabschnitte beginnen mit ##.

---

Listen

Aufzählungen

- Erster Punkt
- Zweiter Punkt
    - Unterpunkt
    - Noch ein Unterpunkt
- Dritter Punkt

• Erster Punkt
• Zweiter Punkt
  • Unterpunkt
  • Noch ein Unterpunkt
• Dritter Punkt

Nummerierte Listen

1. Schritt eins
2. Schritt zwei
3. Schritt drei

1. Schritt eins
2. Schritt zwei
3. Schritt drei

Checklisten

- [x] Erledigt
- [x] Auch erledigt
- [ ] Noch offen

• Erledigt
• Auch erledigt
• Noch offen

---

Hinweisboxen (Admonitions)

Alle Typen

Hinweis

Ein allgemeiner Hinweis für zusätzliche Informationen.

Tipp

Ein nützlicher Tipp oder Best Practice.

Information

Hintergrundinformationen zum Thema.

Erfolg

Etwas hat geklappt oder ist abgeschlossen.

Warnung

Hier ist Vorsicht geboten.

Gefahr

Kritische Warnung — kann zu Datenverlust oder Fehlern führen.

Bug

Ein bekannter Fehler oder bekanntes Problem.

Beispiel

Ein konkretes Anwendungsbeispiel.

Zitat

Ein Zitat oder eine externe Referenz.

Zusammenfassung

Kurzfassung eines längeren Abschnitts.

Frage

Eine häufig gestellte Frage.

Fehlgeschlagen

Etwas ist schiefgelaufen.

Syntax

!!! tip "Titel der Box"
    Inhalt der Box. Einrückung mit 4 Leerzeichen.

Aufklappbare Boxen

Klick mich auf (zugeklappt)

Dieser Inhalt ist zunächst versteckt und wird erst beim Klick sichtbar.

Standardmäßig offen (zuklappbar)

Dieser Inhalt ist initial sichtbar, kann aber zugeklappt werden.

??? tip "Zugeklappt"
    Versteckter Inhalt.

???+ tip "Offen, aber zuklappbar"
    Sichtbarer Inhalt.

---

Code

Inline-Code

Verwende Backticks für inline code oder Dateinamen wie mkdocs.yml.

Code-Blöcke

```python
def hello():
    print("Hello EmergencyForge!")
```

def hello():
    print("Hello EmergencyForge!")

function greet(name) {
  console.log(`Willkommen, ${name}!`);
}

git clone https://github.com/EmergencyForge/Wiki.git
cd Wiki
mkdocs serve

Tipp

Gib immer die Sprache nach den drei Backticks an (python, javascript, bash, yaml, etc.) für korrekte Syntax-Hervorhebung.

---

Tabellen

| Spalte 1 | Spalte 2 | Spalte 3 |
|----------|----------|----------|
| Zeile 1  | Wert A   | Wert B   |
| Zeile 2  | Wert C   | Wert D   |

Spalte 1	Spalte 2	Spalte 3
Zeile 1	Wert A	Wert B
Zeile 2	Wert C	Wert D

---

Tabs

PythonJavaScriptBash

print("Hello!")

console.log("Hello!");

echo "Hello!"

=== "Tab 1"

    Inhalt von Tab 1.

=== "Tab 2"

    Inhalt von Tab 2.

---

Cards

• Beispiel-Card

  ---

  Cards eignen sich gut für Übersichtsseiten mit mehreren Bereichen.

• Noch eine Card

  ---

  Jede Card kann ein Icon, einen Titel und eine Beschreibung haben.

<div class="grid cards" markdown>

- :material-format-paint: **Titel**

    ---

    Beschreibung der Card.

</div>

---

Tastenkürzel

Mit der pymdownx.keys-Erweiterung:

++ctrl+c++ zum Kopieren, ++ctrl+v++ zum Einfügen.

Ctrl+C zum Kopieren, Ctrl+V zum Einfügen.

---

Definitionen

EmergencyForge
:   Ein Projekt im Bereich Notfall- und Einsatzmanagement.

Wiki
:   Eine Sammlung von Wissen, die von der Community gepflegt wird.

EmergencyForge

Ein Projekt im Bereich Notfall- und Einsatzmanagement.

Wiki

Eine Sammlung von Wissen, die von der Community gepflegt wird.

---

Fußnoten

Das ist ein Satz mit einer Fußnote.[^1]

[^1]: Hier steht die Erläuterung zur Fußnote.

Das ist ein Satz mit einer Fußnote.¹

---

Bilder

![Beschreibung](../assets/logo.png){ width="200" }

Bilder werden im Ordner docs/assets/ abgelegt.

---

Horizontale Linie

---

---

Seitenstruktur — Vorlage

Verwende diese Vorlage als Ausgangspunkt für neue Seiten:

---
title: Seitentitel
---

# Seitentitel

Kurze Einleitung — worum geht es auf dieser Seite?

## Erster Abschnitt

Inhalt...

!!! info "Wichtig"
    Zusätzliche Hinweise.

## Zweiter Abschnitt

Weitere Inhalte...

## Siehe auch

- [Verwandte Seite](link.md)

---

1. Hier steht die Erläuterung zur Fußnote. ↩