README

Dies sind die Quellen für OpenChurch.Wiki.

Wissenswertes über dieses Projekt steht auf der Seite "Über dieses Projekt".

MkDocs

Vorbereitung

1. mkdocs installieren. Unter Debian und Ubuntu mit pipx: pipx install mkdocs

2. Die benötigte Python-Erweiterung pymdownx.magiclink installieren: pipx inject mkdocs pymdown-extensions

3. Die Spracherweiterung installieren: pipx inject mkdocs 'mkdocs[i18n]'

4. Das Repository clonen und in das Verzeichnis wechseln: git clone git@codeberg.org:OpenChurch/Wiki.git OpenChurch.Wiki && cd OpenChurch.Wiki

5. Submodule (das Verzeichnis mit den generierten HTML-Dateien) laden:

git submodule init
git submodule update

Vor späteren Änderungen

Änderungen von anderen herunterladen/synchronisieren:

git pull --recurse-submodules

Dies holt auch für das pages-Verzeichnis die letzte verfügbare Version – für den Fall, dass jemand vergessen haben sollte, die Referenz im Wiki-Repo zu aktualisieren (siehe unten).

Lokale Vorschau von Änderungen

1. Betreffende Datei ändern und speichern.
2. Im Projektverzeichnis aufrufen: mkdocs serve
3. Auf http-Link klicken, Browser sollten den lokalen Webserver ansteuern.

Bei Änderungen sollte der Browser automatisch neu geladen werden!

Veröffentlichen von Änderungen

Alle Änderungen hübsch? Dann hochladen!

Das hier ist der manuelle Prozess, für die die es selbst machen wollen und Änderungen sofort online haben wollen. Das wird in Zukunft auch automatisch gehen.

Zeilenweise nacheinander ausführen:

# Seiten generieren
mkdocs build
# In das Verzeichnis mit den generierten Seiten wechseln (Submodule, das auf das pages-Repo verweist)
cd pages
# Änderungen in den Commit aufnehmen
git add .
# Neu generierte Dateien in das lokale Repo committen
git commit add -m "Publish changes"
# Änderungen hochladen = auf openchurch.wiki veröffentlichen
git push
# In das übergeordnete Projektverzeichnis (Wiki) wechseln
cd ..
# Quellenänderungen + die aktuelle Referenz auf das Submodul (pages) in den Commit aufnehmen
git add .
# Quellenänderungen in das lokale Repo committen
git commit add -m "Das und das habe ich ergänzt und das korrigiert"
# Änderungen in das Quellen-Repo übertragen
git push