Dieses repo enthält die offizielle Second-Ride Dokumentation.
Visit our live documentation at: https://docs.second-ride.de
Wichtig: Jeder Ordner benötigt eine index.md Datei, damit die Navigation funktioniert.
docs/
├── index.md # Startseite
├── faq/
│ └── index.md # FAQ-Hauptseite
├── Umbauanleitung/
│ ├── index.md # Übersichtsseite für alle Anleitungen
│ └── SR24/
│ ├── index.md # Übersichtsseite für SR24
│ ├── s50-s51/
│ │ └── index.md # S50/S51 Anleitung
│ ├── schwalbe/
│ │ └── index.md # Schwalbe Anleitung
│ └── duo/
│ └── index.md # Duo Anleitung
└── ...
Schritt 1: Ordner erstellen
- Erstelle einen neuen Ordner mit einem aussagekräftigen Namen (nur Kleinbuchstaben, Bindestriche statt Leerzeichen)
- Beispiel:
S50-anleitungfür eine S50 Anleitung
Schritt 2: index.md Datei erstellen
- In dem neuen Ordner muss eine Datei namens
index.mderstellt werden - Diese Datei enthält den Inhalt der Seite
Schritt 3: Navigation aktualisieren
- Öffne die Datei
mkdocs.yml - Füge deine neue Seite in den
nav:Bereich ein:
nav:
- Home: index.md
- Umbauanleitung:
- SR24:
- S50: Umbauanleitung/SR24/s50-anleitung/index.md # Neue ZeileWas ist eine .md Datei?
- Markdown ist eine einfache Formatierungssprache
- Text wird mit einfachen Zeichen formatiert
Grundlegende Formatierung:
# Große Überschrift
## Mittlere Überschrift
### Kleine Überschrift
**Fett gedruckter Text**
*Kursiver Text*
- Aufzählungspunkt 1
- Aufzählungspunkt 2
[Link Text](https://example.com)
- Ordner erstellen: Erstelle einen
imagesOrdner im gleichen Verzeichnis wie deineindex.md - Bild hochladen: Lade dein Bild in diesen
imagesOrdner - Bild einbinden: Verwende in der Markdown-Datei:

Beispiel-Struktur:
Umbauanleitung/SR24/s50-s51/
├── index.md
└── images/
├── schritt1.jpg
├── schritt2.jpg
└── overview.png
✅ Richtig:
- Ordnername:
s50-anleitung(Kleinbuchstaben, Bindestriche) - Datei:
index.md(immer dieser Name) - Navigation:
- S50: Umbauanleitung/SR24/s50-anleitung/index.md
❌ Falsch:
- Ordnername:
S50 Anleitung(Großbuchstaben, Leerzeichen) - Datei:
S50_Anleitung.md(anderer Name als index.md) - Navigation ohne
index.md
Nach dem Bearbeiten:
- Gehe zu https://docs.second-ride.de
- Überprüfe, ob deine Änderungen sichtbar sind
- Teste alle Links in der Navigation
Problem: Link funktioniert nicht
Lösung: Überprüfe, ob die index.md Datei im richtigen Ordner liegt
Problem: Seite wird nicht in der Navigation angezeigt
Lösung: Überprüfe die mkdocs.yml Datei - ist deine Seite dort eingetragen?
Problem: Bild wird nicht angezeigt Lösung: Überprüfe den Pfad zum Bild (relativ zum Ordner der Markdown-Datei)
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txtmkdocs serveOpens at: http://localhost:8000
mkdocs buildGenerates static files in site/ directory.
For questions about SecondRide or this documentation:
- Browse the FAQ section
- Contact support through the SecondRide platform