Community-Projektdokumentation

🌐 Das zentrale Repository für die Community-Dokumentationen findest du hier.

Die README-Datei des Repositories wird unten angezeigt:

Eine Sammlung von Community-Dokumentationen für das Modded Minecraft Wiki.

📖 Dieses Repository dient als Quelle für inoffizielle Dokumentationen von Minecraft-Projekten, die von der Community beigetragen und vom Entwicklerteam des Modded Minecraft Wiki / Sinytra gepflegt werden.

📂 Jedes Unterverzeichnis (mit Ausnahme von gradle) enthält ein Wiki-Projekt mit Dokumentationsdateien und Metadaten. Die Registrierung der Projekte im Wiki erfolgt automatisch.

🤝 Mitwirken

Wir begrüßen alle Beiträge - Programmierkenntnisse sind nicht erforderlich!

Öffne das Repository in deinem bevorzugten Editor oder IDE. Du kannst auch GitHub Codespaces im Browser für eine schnelle Einrichtung nutzen (unterstützt auch Live-Vorschauen!).
Starte eine lokale Vorschau, indem du im Terminal ./gradlew previewDocs ausführst und wartest, bis die Umgebung fertig eingerichtet ist.
Sobald die Vorschau bereit ist, fordert der Editor dich auf, sie in einem neuen Tab zu öffnen. Klicke auf Open in Browser. Alternativ kannst du einen Link im PORTS-Tab neben dem Terminal finden.
Jetzt kannst du mit dem Bearbeiten der Dokumentation beginnen! 🎉

Weitere Informationen zum verwendeten Dokumentationsdateiformat findest du auf dieser Seite.

Bestehende Projekte

Änderungen an bestehenden Projekten sind ganz einfach. Finde das Projekt, das du aktualisieren möchtest, und nimm die gewünschten Änderungen an den Dokumentationsdateien vor. Wenn du fertig bist, committe deinen Arbeitsstand und erstelle einen Pull Request mit deinen Änderungen.

Neue Projekte

Das Hinzufügen neuer Projekte erfolgt in zwei einfachen Schritten:

Erstelle ein Unterverzeichnis für das Projekt, das du dokumentieren möchtest. Der Name dieses Verzeichnisses sollte dem Wert des id-Felds in der Projekt-Metadatendatei entsprechen.
Füge den Namen des Unterverzeichnisses zur documentation_roots-Eigenschaft in der gradle.properties-Datei hinzu.

✍️ Werde ein Editor

(Registrierung demnächst verfügbar, bleib dran!)