refactor: migrate to docusaurus

.argo/application.yaml

@@ -9,13 +9,13 @@ metadata:
   name: docs-lfk-de
   namespace: argocd
 spec:
-  project: default
+  project: lfk
   source:
     repoURL: "git@git.odit.services:lfk/docs.git"
     path: .argo
     targetRevision: main
   destination:
-    name: odit
+    name: odit-h2
     namespace: lfk
   syncPolicy:
     automated:

.argo/ingress.yaml

@@ -1,5 +1,5 @@
 ---
-apiVersion: traefik.containo.us/v1alpha1
+apiVersion: traefik.io/v1alpha1
 kind: IngressRoute
 metadata:
   name: docs-lfk-de

.argo/kustomization.yaml

@@ -3,6 +3,5 @@ resources:
 - deployment.yaml
 - service.yaml
 - ingress.yaml
-- secret.yaml
 - cert.yaml
 - dns.yaml

.argo/secret.yaml

@@ -1,9 +0,0 @@
-type: kubernetes.io/dockerconfigjson
-apiVersion: v1
-kind: Secret
-metadata:
-  name: registry-odit-services
-  namespace: lfk
-data:
-  .dockerconfigjson: >-
-    eyJhdXRocyI6eyJyZWdpc3RyeS5vZGl0LnNlcnZpY2VzIjp7InVzZXJuYW1lIjoicm9ib3Qkb2RpdF9wdWxsZXIiLCJwYXNzd29yZCI6ImdVYmowaElTRklKUnZuTFlLNzNxQkFBS3VvYUZpM3pzIiwiZW1haWwiOiJib3RAb2RpdC5zZXJ2aWNlcyIsImF1dGgiOiJjbTlpYjNRa2IyUnBkRjl3ZFd4c1pYSTZaMVZpYWpCb1NWTkdTVXBTZG01TVdVczNNM0ZDUVVGTGRXOWhSbWt6ZW5NPSJ9fX0=

.dockerignore

@@ -130,7 +130,6 @@ dist
 
 yarn.lock
 package-lock.json
-build
 
 *.sqlite
 *.sqlite-jurnal

.drone.yml

@@ -1,41 +0,0 @@
----
-kind: secret
-name: docker_username
-get:
-  path: odit-registry-builder
-  name: username
-
----
-kind: secret
-name: docker_password
-get:
-  path: odit-registry-builder
-  name: password
-
----
-kind: pipeline
-type: kubernetes
-name: build:latest
-steps:
-  - name: docker release
-    image: registry.odit.services/library/drone-kaniko
-    settings:
-      username:
-        from_secret: docker_username
-      password:
-        from_secret: docker_password
-      build_args:
-        - NPM_REGISTRY_DOMAIN:
-          from_secret: npmjs_domain
-        - NPM_REGISTRY_TOKEN:
-          from_secret: npmjs_token
-      repo: lfk/docs
-      tags:
-        - latest
-      cache: true
-      registry: registry.odit.services
-trigger:
-  branch:
-    - main
-  event:
-    - push

.gitignore

@@ -1,141 +1,20 @@
-# ---> VisualStudioCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!.vscode/i18n-ally-custom-framework.yml
-*.code-workspace
-
-# Local History for Visual Studio Code
-.history/
-
-# ---> Node
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-
-yarn.lock
-package-lock.json
-build
-
-*.sqlite
-*.sqlite-jurnal
-/docs
-lib
-/oss-attribution
-*.tmp
-pnpm-lock.yaml
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.woodpecker/build.yml

@@ -0,0 +1,20 @@
+steps:
+  - name: build latest
+    image: woodpeckerci/plugin-docker-buildx
+    settings:
+      repo: registry.odit.services/lfk/docs
+      tags:
+        - latest
+      registry: registry.odit.services
+      platforms: linux/amd64,linux/arm64
+      cache_from: registry.odit.services/lfk/docs:latest
+      username:
+        from_secret: odit-registry-builder-username
+      password:
+        from_secret: odit-registry-builder-password
+    secrets:
+      - source: odit-npm-cache-url
+        target: NPM_REGISTRY_URL
+when:
+  branch: main
+  event: push

Dockerfile

@@ -1,11 +1,14 @@
-FROM registry.odit.services/hub/library/node:16.15.1-alpine3.16 AS build
+FROM registry.odit.services/hub/library/node:21.1.0-alpine3.18 AS build
+ARG NPM_REGISTRY_URL=https://registry.npmjs.org
 WORKDIR /app
-COPY package.json *.config.cjs *.config.js ./
-RUN npm config set registry https://$NPM_REGISTRY_DOMAIN && npm config set //$NPM_REGISTRY_DOMAIN/:_authToken $NPM_REGISTRY_TOKEN
-RUN npm i -g pnpm && pnpm i
+
+COPY package.json pnpm-lock.yaml ./
+RUN npm config set registry $NPM_REGISTRY_URL && npm i -g pnpm@8
+RUN pnpm i --frozen-lockfile
 COPY . ./
 RUN pnpm build
+
 # final image
 FROM registry.odit.services/library/nginx-brotli:3.15.130
-COPY --from=build /app/src/.vuepress/dist /usr/share/nginx/html
+COPY --from=build /app/build /usr/share/nginx/html
 COPY ./nginx.conf /etc/nginx/nginx.conf

README.md

@@ -1,34 +1,41 @@
-# @lfk/documentation
-
-The documentation for the LfK! 'Läufersystem'.
-Powered by Vuepress.
-
-The main language for the content is German (since our primary target audience is the Lauf für Kaya! Team at a local German school).
-
-## Quickstart 🐳
-> Use this to run the documentation server via docker.
-
-1. Clone the repo or copy the docker-compose.yml
-2. Cd into the folder containing the docker-compose.yml
-2. Run docker-compose: `docker-compose up -d`
-3. Visit http://127.0.0.1:8080/ to check if the server is running
-
-## Dev Setup 🛠
-> Local dev setup for previewing changes.
-
-1. Install Dependencies
-   ```bash
-   yarn
-   ```
-2. Start the server
-   ```bash
-   yarn dev
-   ```
-
-## Recommended Editor
-
-[Visual Studio Code](https://code.visualstudio.com/)
-
-### Recommended Extensions
-
-* will be automatically recommended via ./vscode/extensions.json
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docker-compose.yml

@@ -3,4 +3,4 @@ services:
   httpd:
     build: .
     ports:
-      - 8080:80
+      - 12345:80

docs/admins/quickstart.md

@@ -1,19 +1,19 @@
-# Schnellstart
-> Du willst das System schnell aufsetzen und testen? Dann bist du hier genau richtig!
-> Um das System für produktive Zwecke einzusetzen schau dir bitte die <router-link to="./installation">Installationsanleitung</router-link> an.
-
-## Voraussetzungen
-Alle der folgenden Anleitungen gehen davon aus, dass du bereits Docker und Docker-Compose installiert hast.
-Die Installationsanleitungen dafür findest du hier:
-* [Docker](https://docs.docker.com/get-docker/)
-* [Docker-Compose](https://docs.docker.com/compose/install/)
-
-## Das ganze System
-> Du willst das ganze System (backend, fronten, document-server) schnell aufsetzen.
-
-1. Klone das lfk/deployment git repo von: https://git.odit.services/lfk/deployment (oder lade es herunter)
-2. Navigiere nach `docker-compose/full_stack`: `cd deployment/docker-compose/full_stack`
-3. Starte das System mit `docker-compose up`
-4. Nachdem alles gestartet ist ist kannst du das Frontend aufrufen: http://localhost:4010 (backend: http://localhost:4010/api/, document-server: http://localhost:4010/documents/)
-
+# Schnellstart
+> Du willst das System schnell aufsetzen und testen? Dann bist du hier genau richtig!
+> Um das System für produktive Zwecke einzusetzen schau dir bitte die <router-link to="./installation">Installationsanleitung</router-link> an.
+
+## Voraussetzungen
+Alle der folgenden Anleitungen gehen davon aus, dass du bereits Docker und Docker-Compose installiert hast.
+Die Installationsanleitungen dafür findest du hier:
+* [Docker](https://docs.docker.com/get-docker/)
+* [Docker-Compose](https://docs.docker.com/compose/install/)
+
+## Das ganze System
+> Du willst das ganze System (backend, fronten, document-server) schnell aufsetzen.
+
+1. Klone das lfk/deployment git repo von: https://git.odit.services/lfk/deployment (oder lade es herunter)
+2. Navigiere nach `docker-compose/full_stack`: `cd deployment/docker-compose/full_stack`
+3. Starte das System mit `docker-compose up`
+4. Nachdem alles gestartet ist ist kannst du das Frontend aufrufen: http://localhost:4010 (backend: http://localhost:4010/api/, document-server: http://localhost:4010/documents/)
+
 Bei Bedarf können die Ports und andere Einstellungen im docker-compose.yml angepasst werden.

docs/beamershow/config.md

@@ -2,11 +2,11 @@
 > Wie man die Beamershow konfiguriert
 
 ## Start
-Wenn du die Beamershow öffnest wirst du als erstes nach dem API Endpunkt gefragt - diese entspricht der URL des Läufersystems (z.B.: `https://dev.lauf-fuer-kaya.de`).<br>
+Wenn du die Beamershow öffnest wirst du als erstes nach dem API Endpunkt gefragt - diese entspricht der URL des Läufersystems (z.B.: `https://dev.lauf-fuer-kaya.de`).<br/>
 Als nächstes musst du noch einen Client Token gefragt, den du von deinem Admin bekommst.
 
 Sobald du den Token eingegeben hast kannst du auf den Button "Konfigurieren" klicken und die Beamershow wird gestartet.
 
 ## Konfiguration ändern
-Tippe `cnf` auf einer beliebigen Seite der Beamershow.<br>
+Tippe `cnf` auf einer beliebigen Seite der Beamershow.<br/>
 Du wirst sofort von der Beamershow abbemeldet und kannst so einen neuen API Endpunkt und Client Token angeben.

docs/scanstations/config.md

@@ -5,7 +5,7 @@
 Wenn du die Scanclient Software öffnest wirst du als erstes nach einem API Endpunkt gefragt.
 Hier musst du die URL deines LfK-Backends eintragen (z.B.: `https://dev.lauf-fuer-kaya.de`).
 
-Als nächstes musst du noch einen Client Token gefragt -> <router-link to="../users/scanstations.html">So kommst du an einen Client token</router-link><br>
+Als nächstes musst du noch einen Client Token gefragt -> <router-link to="../users/scanstations.html">So kommst du an einen Client token</router-link><br/>
 Solltest du dich beim API-Endpunkt vertippt haben kannst du hier auch `rst` eingeben, um diesen nochmal zu setzen.
 
 Sobald du den Token eingegeben hast kannst du auf den Button "Konfigurieren" klicken und der Scanclient wird gestartet.

docs/scanstations/config_scanners.md

@@ -1,26 +1,31 @@
-# Scannerkonfiguration
-> Achtung: Diese Konfiguratiuon wurde nur mit GD4130-BK/WH USB Scannern getestet
-> Donload als PDF: [Scannerkonfiguration.pdf](/files/scannerconfig.pdf)
-
-## 1. Werkseinstellungen wiederherstellen
-![Factory reset](/images/barcode_config/00_factory_reset.png)
-
-## 2. Programming Mode Aktivieren
-![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
-
-## 3. Nur EAN-13 scannen (optional)
-![Check EAN Checkdigit](/images/barcode_config/02_disable_all.png)
-![Disable EAN Checkdigit](/images/barcode_config/03_enable_ean.png)
-
-## 4. EAN13 Check-Zahl überprüfen, aber nicht übertragen
-![Disable EAN Checkdigit](/images/barcode_config/05_disable_ean_digit.png)
-
-## 5. Scanner auf always on stellen (optional)
-![Scan mode: Always on](/images/barcode_config/06_always_on.png)
-## 6. Programming Mode Verlassen
-![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
-
-## 7. Beep ausschalten (optional)
-![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
-![Scan mode: Always on](/images/barcode_config/07_beep_off.png)
-![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
+# Scannerkonfiguration
+> Achtung: Diese Konfiguratiuon wurde nur mit GD4130-BK/WH USB Scannern getestet
+> Download als PDF: [Scannerkonfiguration.pdf](/files/scannerconfig.pdf)
+
+## 1. Werkseinstellungen wiederherstellen
+![Factory reset](/images/barcode_config/00_factory_reset.png)
+
+## 2. Programming Mode Aktivieren
+![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
+
+## 3. Nur EAN-13 scannen (optional)
+![Check EAN Checkdigit](/images/barcode_config/02_disable_all.png)
+![Disable EAN Checkdigit](/images/barcode_config/03_enable_ean.png)
+
+## 4. EAN13 Check-Zahl überprüfen, aber nicht übertragen
+![Disable EAN Checkdigit](/images/barcode_config/05_disable_ean_digit.png)
+
+## 5. Scanner auf always on stellen (optional)
+![Scan mode: Always on](/images/barcode_config/06_always_on.png)
+## 6. Programming Mode Verlassen
+![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
+
+## 7. Beep ausschalten (optional)
+![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
+![Scan mode: Always on](/images/barcode_config/07_beep_off.png)
+![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
+
+## 8. Tastatur auf Deutsch stellen (optional)
+![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)
+![Country Mode: Germany](/images/barcode_config/08_countrycode_germany.png)
+![Enter/Exit Programming Mode](/images/barcode_config/01_programming-mode.png)

docs/scanstations/hardware.md

@@ -1,12 +1,12 @@
-# Hardwareempfehlungen
-> Known-good Hardware, die wir für die Scannerstationen empfehlen können
-
-## Computer
-* Raspberry Pi 3 oder neuer
-* Prozessor: Minimum: Intel Core 2 Duo
-* Arbeitsspeicher: Minimum 4GB
-
-## Barcodescanner
-* Datalogic Gryphon GD4130-BK/WH USB Scanner
-* Datalogic Gryphon GD4132-BK/WH USB Scanner
-* Datalogic Gryphon GD4200 USB Scanner
+# Hardwareempfehlungen
+> Known-good Hardware, die wir für die Scannerstationen empfehlen können
+
+## Computer
+* Raspberry Pi 3 oder neuer
+* Prozessor: Minimum: Intel Core 2 Duo
+* Arbeitsspeicher: Minimum 4GB
+
+## Barcodescanner
+* Datalogic Gryphon GD4130-BK/WH USB Scanner (1D)
+* Datalogic Gryphon GD4200 USB Scanner (1D)
+* Datalogic Gryphon GD4400 USB Scanner (2D)

docs/selfservice/README.md

@@ -8,4 +8,6 @@ Genauer gibt es folgende Funktionen:
   * Stammdaten: Vorname, Mittelname, Nachname, E-Mail Adresse, Telefonnummer
   * Rundenzeiten
 * Herunterladen der eigenen Läuferurkunde
-* Restloses löschen der eigenen Daten aus dem System
+* Restloses löschen der eigenen Daten aus dem System
+
+Achtung: Damit der Selfservice für Bürgerläufer funktioniert, muss die automatisch generierte Bürgerlauf-Organisation existieren!

docs/users/organizations.md

@@ -1,36 +1,36 @@
-# Organisationen
-> Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu <router-link to="../selfservice/org_selfservice">hier</router-link>
-
-Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer.
-Eine Organisation kann eine Firma, Schule, Kindergarten, Verein oder ähnliches sein.
-
-Läufer:innen können direkt einer Organisation zugeordnet werden.
-Um die Läufer:innen einer Organisation (z.B.: Schule) weiter zu sortieren können einer Organisation mehrere Teams (z.B.: Klassen) zugeordnet werden.
-Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du <router-link to="./contacts">hier</router-link>.
-Mehr zu Teams findest du <router-link to="./teams">hier</router-link>
-
-## Anlegen
-Um eine neue Organisation anzulegen öffne im Läufersystem die Seite `Orgs`.
-Über den Button `Organisation erstellen` kannst du eine neue Organisation erstellen.
-Dabei kannst du der Organisation einen Namen geben.
-
-## Bearbeiten
-Um eine Organisation zu bearbeiten kannst du in der Organisationsübersicht den Button `Details` für die gewünschte Organisation anklicken.
-In der Übersicht für diese Organisation kannst du nun den Namen der Organisation und den zugewiesenen Kontakt ändern.
-Wenn du fertig bist klick einfach auf `Änderungen speichern`.
-
-## Löschen
-> Du kannst eine Organisation entweder aus der Organisationsübersicht oder der Organisationsdetailansicht löschen.
-
-### In der Organisationsübersicht
-Klick bei der gewünschten Organisation auf den Button `Löschen`.
-Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst.
-
-### In der Organisationsdetailansicht
-Klick bei der gewünschten Organisation auf den Button `Details`.
-Oben auf der Seite gibt es jetzt den Knopf `Organisation löschen`.
-Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst.
-
-### Organisation mit Teams und Läufer
-Sollte die Organisation noch Teams und/oder Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
+# Organisationen
+> Solltest du dich für den Selfservice für Orgs interessieren findest du die Dokumentation zu <router-link to="../selfservice/org_selfservice">hier</router-link>
+
+Läuferorganisationen sind das Herzstück des Gruppensystems für Läufer.
+Eine Organisation kann eine Firma, Schule, Kindergarten, Verein oder ähnliches sein.
+
+Läufer:innen können direkt einer Organisation zugeordnet werden.
+Um die Läufer:innen einer Organisation (z.B.: Schule) weiter zu sortieren können einer Organisation mehrere Teams (z.B.: Klassen) zugeordnet werden.
+Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du <router-link to="./contacts">hier</router-link>.
+Mehr zu Teams findest du <router-link to="./teams">hier</router-link>
+
+## Anlegen
+Um eine neue Organisation anzulegen öffne im Läufersystem die Seite `Orgs`.
+Über den Button `Organisation erstellen` kannst du eine neue Organisation erstellen.
+Dabei kannst du der Organisation einen Namen geben.
+
+## Bearbeiten
+Um eine Organisation zu bearbeiten kannst du in der Organisationsübersicht den Button `Details` für die gewünschte Organisation anklicken.
+In der Übersicht für diese Organisation kannst du nun den Namen der Organisation und den zugewiesenen Kontakt ändern.
+Wenn du fertig bist klick einfach auf `Änderungen speichern`.
+
+## Löschen
+> Du kannst eine Organisation entweder aus der Organisationsübersicht oder der Organisationsdetailansicht löschen.
+
+### In der Organisationsübersicht
+Klick bei der gewünschten Organisation auf den Button `Löschen`.
+Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst.
+
+### In der Organisationsdetailansicht
+Klick bei der gewünschten Organisation auf den Button `Details`.
+Oben auf der Seite gibt es jetzt den Knopf `Organisation löschen`.
+Daraufhin wirst du gefragt, ob du die Organisation wirklich löschen oder abbrechen willst.
+
+### Organisation mit Teams und Läufer
+Sollte die Organisation noch Teams und/oder Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
 Hier musst du nochmal die Löschung inklusive aller Läufer und Teams bestätigen, alternativ kannst du auch Abbrechen.

docs/users/runner_import.md

@@ -1,109 +1,109 @@
-# Läuferimport
-
-Um das Eintragen von Läufer:innen ins System zu erleichtern können Läufer aus Excel-Tabellen(CSV, XLSX) importiert werden.
-Diese Funktion ist vor allem für Schulen und Kindergärten gedacht, kann aber natürlich für alle Arten von Teams und Organisationen verwendet werden.
-Im Folgenden erklären wir dir Schritt für Schritt, wie du Läufer ins System importieren kannst.
-
-## Aufbau der Importdateien
-> Die Datei muss im Format XLSX(Excel) oder CSV vorliegen
-
-Alle Läufer müssen auf einem "Tabellenblatt"(Excel) stehen, alle weiteren Tabellenblätter werden ignoriert.
-Die Tabelle muss folgendem Schema folgen:
-Vorname | Mittelname | Nachname | Team/Klasse
-- | - | - | -
-Vorname1 | Optional | Nachname1 | Optional
-
-Achtung: Die Team Spalte kann Team oder Klasse heißen!
-
-### Beispiel: CSV
-
-**Mit Mittelname**
-> [Beispieldatei herunterladen](/files/class_with_middlename.csv)
-
-```
-Vorname; Mittelname; Nachname; Team;
-Peter; ; Tester; 1A
-Manuel; Steffen; Regenwald; 1A
-Toller; ; Typ; 2A 
-```
-
-**Ohne Mittelname**
-> [Beispieldatei herunterladen](/files/class_without_middlename.csv)
-
-```
-Vorname; Nachname; Team;
-Peter; Tester; 1A
-Manuel; Regenwald; 1A
-Toller; Typ; 2A 
-```
-
-### Beispiel: XLSX (Excel)
-**Mit Mittelname**
-> [Beispieldatei herunterladen](/files/class_with_middlename.xlsx)
-
-![Excel Screenshot with Middlename](/images/runner_import_excel_with_middlename.png)
-
-
-**Ohne Mittelname**
-> [Beispieldatei herunterladen](/files/class_without_middlename.xlsx)
-
-![Excel Screenshot with Middlename](/images/runner_import_excel_no_middlename.png)
-
-## Import in eine Organisation
-> Wähle diese Variante, wenn du in einer Organisation automatisch Teams anlegen und die Läufer in diese Importieren willst. <br>
-> Wähle diese Variante, wenn du Läufer direkt in eine Organisation importieren willst.
-
-Wenn in der Datei bei einer Läufer:in kein Team angegeben ist wird sie direkt in die Organisation importiert.
-Ist ein Team angegeben wird das Team in der Organisation gesucht und neu Angelegt, wenn es nicht gefunden wurde - danach wird die Läufer:in in das Team importiert.
-
-### Aus der Organisationsübersicht
-1. Öffne im Läufersystem die Seite `Orgs`
-2. Klicke oben auf `Läufer importieren`
-3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
-4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
-5. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen
-6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
-7. Die Läufer werden nun in die Organisation importiert
-
-### Aus der Organisationsdetailansicht
-1. Öffne im Läufersystem die Seite `Orgs`
-2. Klicke bei der gewünschten Organisation auf den `Details` Button
-3. Klicke oben auf `Läufer importieren`
-4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
-5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
-6. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen
-7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
-8. Die Läufer werden nun in die Organisation importiert
-
-### Aus der Läuferübersicht
-1. Öffne im Läufersystem die Seite `Läufer`
-2. Klicke oben auf `Läufer importieren`
-3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
-4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
-5. Wähle oben die Organisation (Hat kein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen
-6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
-7. Die Läufer werden nun in die Organisation importiert
-
-## Import in ein Team
-> Wähle diese Variante, wenn du Läufer direkt in ein Team importieren willst.
-
-Wenn in der Datei bei einer Läufer:in ein Team angegeben ist wird dieses ignoriert und mit dem gewählten Team überschrieben..
-
-### Aus der Teamdetailansicht
-1. Öffne im Läufersystem die Seite `Teams`
-2. Klicke bei de, gewünschten Team auf den `Details` Button
-3. Klicke oben auf `Läufer importieren`
-4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
-5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
-6. Wähle oben das Team aus, in die die Läufer:innen importiert werden sollen
-7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
-8. Die Läufer werden nun in das Team importiert
-
-### Aus der Läuferübersicht
-1. Öffne im Läufersystem die Seite `Läufer`
-2. Klicke oben auf `Läufer importieren`
-3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
-4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
-5. Wähle oben das Team (Hat ein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen
-6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
+# Läuferimport
+
+Um das Eintragen von Läufer:innen ins System zu erleichtern können Läufer aus Excel-Tabellen(CSV, XLSX) importiert werden.
+Diese Funktion ist vor allem für Schulen und Kindergärten gedacht, kann aber natürlich für alle Arten von Teams und Organisationen verwendet werden.
+Im Folgenden erklären wir dir Schritt für Schritt, wie du Läufer ins System importieren kannst.
+
+## Aufbau der Importdateien
+> Die Datei muss im Format XLSX(Excel) oder CSV vorliegen
+
+Alle Läufer müssen auf einem "Tabellenblatt"(Excel) stehen, alle weiteren Tabellenblätter werden ignoriert.
+Die Tabelle muss folgendem Schema folgen:
+Vorname | Mittelname | Nachname | Team/Klasse
+- | - | - | -
+Vorname1 | Optional | Nachname1 | Optional
+
+Achtung: Die Team Spalte kann Team oder Klasse heißen!
+
+### Beispiel: CSV
+
+**Mit Mittelname**
+> [Beispieldatei herunterladen](/files/class_with_middlename.csv)
+
+```
+Vorname; Mittelname; Nachname; Team;
+Peter; ; Tester; 1A
+Manuel; Steffen; Regenwald; 1A
+Toller; ; Typ; 2A 
+```
+
+**Ohne Mittelname**
+> [Beispieldatei herunterladen](/files/class_without_middlename.csv)
+
+```
+Vorname; Nachname; Team;
+Peter; Tester; 1A
+Manuel; Regenwald; 1A
+Toller; Typ; 2A 
+```
+
+### Beispiel: XLSX (Excel)
+**Mit Mittelname**
+> [Beispieldatei herunterladen](/files/class_with_middlename.xlsx)
+
+![Excel Screenshot with Middlename](/images/runner_import_excel_with_middlename.png)
+
+
+**Ohne Mittelname**
+> [Beispieldatei herunterladen](/files/class_without_middlename.xlsx)
+
+![Excel Screenshot with Middlename](/images/runner_import_excel_no_middlename.png)
+
+## Import in eine Organisation
+> Wähle diese Variante, wenn du in einer Organisation automatisch Teams anlegen und die Läufer in diese Importieren willst. <br/>
+> Wähle diese Variante, wenn du Läufer direkt in eine Organisation importieren willst.
+
+Wenn in der Datei bei einer Läufer:in kein Team angegeben ist wird sie direkt in die Organisation importiert.
+Ist ein Team angegeben wird das Team in der Organisation gesucht und neu Angelegt, wenn es nicht gefunden wurde - danach wird die Läufer:in in das Team importiert.
+
+### Aus der Organisationsübersicht
+1. Öffne im Läufersystem die Seite `Orgs`
+2. Klicke oben auf `Läufer importieren`
+3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
+4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
+5. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen
+6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
+7. Die Läufer werden nun in die Organisation importiert
+
+### Aus der Organisationsdetailansicht
+1. Öffne im Läufersystem die Seite `Orgs`
+2. Klicke bei der gewünschten Organisation auf den `Details` Button
+3. Klicke oben auf `Läufer importieren`
+4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
+5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
+6. Wähle oben die Organisation aus, in die die Läufer:innen importiert werden sollen
+7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
+8. Die Läufer werden nun in die Organisation importiert
+
+### Aus der Läuferübersicht
+1. Öffne im Läufersystem die Seite `Läufer`
+2. Klicke oben auf `Läufer importieren`
+3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
+4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
+5. Wähle oben die Organisation (Hat kein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen
+6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
+7. Die Läufer werden nun in die Organisation importiert
+
+## Import in ein Team
+> Wähle diese Variante, wenn du Läufer direkt in ein Team importieren willst.
+
+Wenn in der Datei bei einer Läufer:in ein Team angegeben ist wird dieses ignoriert und mit dem gewählten Team überschrieben..
+
+### Aus der Teamdetailansicht
+1. Öffne im Läufersystem die Seite `Teams`
+2. Klicke bei de, gewünschten Team auf den `Details` Button
+3. Klicke oben auf `Läufer importieren`
+4. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
+5. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
+6. Wähle oben das Team aus, in die die Läufer:innen importiert werden sollen
+7. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
+8. Die Läufer werden nun in das Team importiert
+
+### Aus der Läuferübersicht
+1. Öffne im Läufersystem die Seite `Läufer`
+2. Klicke oben auf `Läufer importieren`
+3. Klicke auf `Datei auswählen` und wähle die Datei aus, aus der du Läufer:innen importieren willst
+4. Dir wird eine Übersicht aller Läufer:innen angezeigt, die in der Datei gefunden wurden - überprüfe alle Läufer:innen auf Korrektheit
+5. Wähle oben das Team (Hat ein `>` im Namen) aus, in die die Läufer:innen importiert werden sollen
+6. Klicke unten auf `Läufer importieren`, um die Läufer:innen zu importieren oder `Abbrechen`, um den Import abzubrechen
 7. Die Läufer werden nun in das Team importiert

docs/users/runners.md

@@ -1,54 +1,54 @@
-# Läufer:innen
-
-Läufer sind das Herzstück des Läufersystems.
-Über sie werden Strecken erfasst und Spenden berechnet.
-
-Läufer können einem <router-link to="./teams">Team</router-link> oder einer <router-link to="./organizations">Organisation</router-link> zugeordnet werden.
-
-## Läuferübersicht
-> Eine kurze Übersicht über die Funktionen der Läuferübersicht.
-
-In der Läuferübersicht werden alle im System registrierten Läufer:innen aufgelistet.
-Von hier aus kannst du einzelne Läufer:innen hinzufügen, bearbeiten oder löschen.
-
-Um die Suche nach einzelnen Läufer:innen zu erleichtern gibt es einen Filter nach Teams und Organisationen.
-Wenn du mehrere Teams/Organisationen in den Filter packst werden dir alle Läufer:innen angezeigt, die in einem/r der Teams/Organisationen registriert sind angezeigt.
-
-Ebenso gibt es eine Suchfunktion mit Hilfe derer du nach Läufernamen, -IDs und Gruppen (Teams/Organisationen) suchen kannst.
-Du eine ID eingibst wird dir nur die Läufer:in mit genau der ID angezeigt, solltest du alle Läufer:innen sehen wollen, deren IDs mit deiner Eingabe beginnen stelle ein `*` ans Ende der ID.
-
-Beispiele:
-* `Peter` -> Alle Läufer:innen mit Peter im Namen 
-* `Gymnasium` -> Alle Läufer:innen, die in einer Gruppe mit dem Namen Gymnasium sind
-* `421` -> Die Läufer:in mit der ID 421
-* `42*` -> Alle Läufer:innen, deren ID mit 42 beginnt
-
-## Aktionen
-
-### Anlegen
-> Achtung: Um eine Läufer:in anzulegen musst du vorher eine Organisation und/oder ein Team anlegen.
-
-Um eine neue Läufer:in anzulegen öffne im Läufersystem die Seite `Läufer`.
-Über den Button `Läufer:in hinzufügen` kannst du eine neue Läufer:in anlegen.
-Dabei musst du einen Vornamen, Nachnamen und die Gruppe (Team/Organisation) festlegen.
-Zusätzlich kannst du einen Mittelnamen(2. Vornamen), eine Telefonnummer und eine E-Mail Adresse angeben.
-
-### Bearbeiten
-Um eine Läufer:in zu bearbeiten kannst du in der Läuferübersicht den Button `Details` für die gewünschte Läufer:in anklicken.
-In der Übersicht für die Läufer:in kannst du nun den Vornamen, Mittelnamen, Nachnamen, sowie die Telefonnummer, E-Mail Adresse und Gruppe bearbeiten.
-Wenn du fertig bist klick einfach auf `Änderungen speichern`.
-
-### Löschen
-> Du kannst eine Läufer:in entweder aus der Läuferübersicht oder der Läuferdetailansicht löschen.
-
-### In der Läuferübersicht
-Klick bei der gewünschten Läufer:in auf den Button `Löschen`.
-Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst.
-
-### In der Läuferdetailansicht
-Klick bei der gewünschten Läufer:in auf den Button `Details`.
-Oben auf der Seite gibt es jetzt den Knopf `Läufer:in löschen`.
-Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst.
-
-## Import 
+# Läufer:innen
+
+Läufer sind das Herzstück des Läufersystems.
+Über sie werden Strecken erfasst und Spenden berechnet.
+
+Läufer können einem <router-link to="./teams">Team</router-link> oder einer <router-link to="./organizations">Organisation</router-link> zugeordnet werden.
+
+## Läuferübersicht
+> Eine kurze Übersicht über die Funktionen der Läuferübersicht.
+
+In der Läuferübersicht werden alle im System registrierten Läufer:innen aufgelistet.
+Von hier aus kannst du einzelne Läufer:innen hinzufügen, bearbeiten oder löschen.
+
+Um die Suche nach einzelnen Läufer:innen zu erleichtern gibt es einen Filter nach Teams und Organisationen.
+Wenn du mehrere Teams/Organisationen in den Filter packst werden dir alle Läufer:innen angezeigt, die in einem/r der Teams/Organisationen registriert sind angezeigt.
+
+Ebenso gibt es eine Suchfunktion mit Hilfe derer du nach Läufernamen, -IDs und Gruppen (Teams/Organisationen) suchen kannst.
+Du eine ID eingibst wird dir nur die Läufer:in mit genau der ID angezeigt, solltest du alle Läufer:innen sehen wollen, deren IDs mit deiner Eingabe beginnen stelle ein `*` ans Ende der ID.
+
+Beispiele:
+* `Peter` -> Alle Läufer:innen mit Peter im Namen 
+* `Gymnasium` -> Alle Läufer:innen, die in einer Gruppe mit dem Namen Gymnasium sind
+* `421` -> Die Läufer:in mit der ID 421
+* `42*` -> Alle Läufer:innen, deren ID mit 42 beginnt
+
+## Aktionen
+
+### Anlegen
+> Achtung: Um eine Läufer:in anzulegen musst du vorher eine Organisation und/oder ein Team anlegen.
+
+Um eine neue Läufer:in anzulegen öffne im Läufersystem die Seite `Läufer`.
+Über den Button `Läufer:in hinzufügen` kannst du eine neue Läufer:in anlegen.
+Dabei musst du einen Vornamen, Nachnamen und die Gruppe (Team/Organisation) festlegen.
+Zusätzlich kannst du einen Mittelnamen(2. Vornamen), eine Telefonnummer und eine E-Mail Adresse angeben.
+
+### Bearbeiten
+Um eine Läufer:in zu bearbeiten kannst du in der Läuferübersicht den Button `Details` für die gewünschte Läufer:in anklicken.
+In der Übersicht für die Läufer:in kannst du nun den Vornamen, Mittelnamen, Nachnamen, sowie die Telefonnummer, E-Mail Adresse und Gruppe bearbeiten.
+Wenn du fertig bist klick einfach auf `Änderungen speichern`.
+
+### Löschen
+> Du kannst eine Läufer:in entweder aus der Läuferübersicht oder der Läuferdetailansicht löschen.
+
+### In der Läuferübersicht
+Klick bei der gewünschten Läufer:in auf den Button `Löschen`.
+Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst.
+
+### In der Läuferdetailansicht
+Klick bei der gewünschten Läufer:in auf den Button `Details`.
+Oben auf der Seite gibt es jetzt den Knopf `Läufer:in löschen`.
+Daraufhin wirst du gefragt, ob du die Läufer:in wirklich löschen oder abbrechen willst.
+
+## Import 
 > Die Importanleitung findest du <router-link to="./runner_import">hier</router-link>

docs/users/teams.md

@@ -1,35 +1,35 @@
-# Teams
-
-Läuferteams sind die Untergruppen des Gruppensystems für Läufer:innen.
-Ein Team kann eine Klasse, Abteilung, Gruppe oder ähnliches sein.
-
-Läufer:innen können einem Team zugeordnet werden, das wiederum zu einer Organisation gehört (mehr zu Organisationen findest du <router-link to="./organizations">hier</router-link>).
-Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du <router-link to="./contacts">hier</router-link>.
-
-## Anlegen
-> Achtung: Um ein Team anzulegen musst du vorher die Mutter-Organisation für das Team anlegen.
-
-Um ein neues Team anzulegen öffne im Läufersystem die Seite `Teams`.
-Über den Button `Team erstellen` kannst du ein neues Team erstellen.
-Dabei kannst du dem Team einen Namen geben und auswählen, zu welcher Organisation das Team gehört.
-
-## Bearbeiten
-Um ein Team zu bearbeiten kannst du in der Teamübersicht den Button `Details` für das gewünschte Team anklicken.
-In der Übersicht für dieses Team kannst du nun den Namen, die Mutter-Organisation und den Kontakt des Teams ändern.
-Wenn du fertig bist klick einfach auf `Änderungen speichern`.
-
-## Löschen
-> Du kannst ein Team entweder aus der Teamübersicht oder der Teamdetailansicht löschen.
-
-### In der Teamübersicht
-Klick bei dem gewünschten Team auf den Button `Löschen`.
-Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst.
-
-### In der Teamdetailansicht
-Klick bei dem gewünschten Team auf den Button `Details`.
-Oben auf der Seite gibt es jetzt den Knopf `Team löschen`.
-Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst.
-
-### Teams mit Läufern
-Sollte das Team noch Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
+# Teams
+
+Läuferteams sind die Untergruppen des Gruppensystems für Läufer:innen.
+Ein Team kann eine Klasse, Abteilung, Gruppe oder ähnliches sein.
+
+Läufer:innen können einem Team zugeordnet werden, das wiederum zu einer Organisation gehört (mehr zu Organisationen findest du <router-link to="./organizations">hier</router-link>).
+Einer/m Organisation/Team kann ein Kontakt zugeordnet werden, mehr dazu findest du <router-link to="./contacts">hier</router-link>.
+
+## Anlegen
+> Achtung: Um ein Team anzulegen musst du vorher die Mutter-Organisation für das Team anlegen.
+
+Um ein neues Team anzulegen öffne im Läufersystem die Seite `Teams`.
+Über den Button `Team erstellen` kannst du ein neues Team erstellen.
+Dabei kannst du dem Team einen Namen geben und auswählen, zu welcher Organisation das Team gehört.
+
+## Bearbeiten
+Um ein Team zu bearbeiten kannst du in der Teamübersicht den Button `Details` für das gewünschte Team anklicken.
+In der Übersicht für dieses Team kannst du nun den Namen, die Mutter-Organisation und den Kontakt des Teams ändern.
+Wenn du fertig bist klick einfach auf `Änderungen speichern`.
+
+## Löschen
+> Du kannst ein Team entweder aus der Teamübersicht oder der Teamdetailansicht löschen.
+
+### In der Teamübersicht
+Klick bei dem gewünschten Team auf den Button `Löschen`.
+Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst.
+
+### In der Teamdetailansicht
+Klick bei dem gewünschten Team auf den Button `Details`.
+Oben auf der Seite gibt es jetzt den Knopf `Team löschen`.
+Daraufhin wirst du gefragt, ob du das Team wirklich löschen oder abbrechen willst.
+
+### Teams mit Läufern
+Sollte das Team noch Läufer haben geht nach dem Bestätigen der Löschung nochmal eine Warnung auf.
 Hier musst du nochmal die Löschung inklusive aller Läufer bestätigen, alternativ kannst du auch Abbrechen.

docusaurus.config.js

@@ -0,0 +1,114 @@
+// @ts-check
+// `@type` JSDoc annotations allow editor autocompletion and type checking
+// (when paired with `@ts-check`).
+// There are various equivalent ways to declare your Docusaurus config.
+// See: https://docusaurus.io/docs/api/docusaurus-config
+
+import {themes as prismThemes} from 'prism-react-renderer';
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'LfK! Docs',
+  tagline: 'LfK! Dokumentation',
+  favicon: 'img/favicon.ico',
+
+  // Set the production url of your site here
+  url: 'https://your-docusaurus-site.example.com',
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: '/',
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  // Even if you don't use internationalization, you can use this field to set
+  // useful metadata like html lang. For example, if your site is Chinese, you
+  // may want to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'de',
+    locales: ['de'],
+  },
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          sidebarPath: './sidebars.js',
+        },
+        blog: {
+          showReadingTime: true,
+        },
+        theme: {
+          customCss: './src/css/custom.css',
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      // Replace with your project's social card
+      image: 'img/docusaurus-social-card.jpg',
+      navbar: {
+        title: 'LfK! Docs',
+        logo: {
+          alt: 'LfK! Docs Logo',
+          src: 'img/logo.svg',
+        },
+        items: [
+          {
+            type: 'docSidebar',
+            sidebarId: 'tutorialSidebar',
+            position: 'left',
+            label: 'Docs',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'Docs',
+                to: '/docs/admins',
+              },
+            ],
+          },
+          {
+            title: 'Legal',
+            items: [
+              {
+                label: 'Imprint',
+                href: 'https://odit.services/imprint/',
+              },
+              {
+                label: 'Privacy',
+                href: 'https://odit.services/privacy/',
+              },
+            ],
+          },
+          {
+            title: 'More',
+            items: [
+              {
+                label: 'Code',
+                href: 'https://git.odit.services/lfk/',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} ODIT.Services`,
+      },
+      prism: {
+        theme: prismThemes.github,
+        darkTheme: prismThemes.dracula,
+      },
+    }),
+};
+
+export default config;

package.json

@@ -1,8 +1,7 @@
 {
-  "name": "@odit/lfk-docs",
-  "version": "0.0.1",
-  "description": "The documentation for the LfK! 'Läufersystem'.",
-  "main": "index.js",
+  "name": "@lfk/docs",
+  "version": "1.0.0",
+  "license": "CC-BY-NC-SA-4.0",
   "author": {
     "name": "ODIT.Services",
     "email": "info@odit.services",
@@ -25,20 +24,39 @@
     "url": "git@git.odit.services:lfk/docs.git"
   },
   "scripts": {
-    "dev": "vuepress dev src",
-    "build": "vuepress build src",
-    "licenses:export": "license-exporter --markdown"
-  },
-  "license": "CC-BY-NC-SA-4.0",
-  "devDependencies": {
-    "@odit/license-exporter": "0.0.12",
-    "vuepress": "1.9.7"
+    "docusaurus": "docusaurus",
+    "dev": "docusaurus start",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "vuepress-plugin-flexsearch": "0.3.0",
-    "vuepress-theme-default-prefers-color-scheme": "2.0.0"
+    "@docusaurus/core": "3.0.0",
+    "@docusaurus/preset-classic": "3.0.0",
+    "@mdx-js/react": "3.0.0",
+    "clsx": "1.2.1",
+    "prism-react-renderer": "2.1.0",
+    "react": "18.0.0",
+    "react-dom": "18.0.0"
   },
-  "volta": {
-    "node": "18.10.0"
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "3.0.0",
+    "@docusaurus/types": "3.0.0"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 3 chrome version",
+      "last 3 firefox version",
+      "last 5 safari version"
+    ]
   }
 }

sidebars.js

@@ -0,0 +1,33 @@
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+
+// @ts-check
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  // By default, Docusaurus generates a sidebar from the docs folder structure
+  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+
+  // But you can create a sidebar manually
+  /*
+  tutorialSidebar: [
+    'intro',
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+   */
+};
+
+export default sidebars;

src/.vuepress/components/Foo/Bar.vue

@@ -1,15 +0,0 @@
-<template>
-  <p class="demo">
-    {{ msg }}
-  </p>
-</template>
-
-<script>
-  export default {
-    data () {
-      return {
-        msg: 'Hello this is <Foo-Bar>'
-      }
-    }
-  }
-</script>

src/.vuepress/components/OtherComponent.vue

@@ -1,3 +0,0 @@
-<template>
-  <p class="demo">This is another component</p>
-</template>

src/.vuepress/components/demo-component.vue

@@ -1,15 +0,0 @@
-<template>
-  <p class="demo">
-    {{ msg }}
-  </p>
-</template>
-
-<script>
-  export default {
-    data() {
-      return {
-        msg: 'Hello this is <demo-component>'
-      }
-    }
-  }
-</script>

src/.vuepress/config.js

@@ -1,172 +0,0 @@
-const { description } = require('../../package')
-
-module.exports = {
-  locales: {
-    '/': {
-      lang: 'de-DE',
-      title: 'LfK! Dokumentation',
-      description: 'Dokumentation für das Lauf für Kaya! Läufersystem'
-    },
-    '/en/': {
-      lang: 'en-US',
-      title: 'LfK! Documentation',
-      description: 'The official documentation for the LfK! "Läufersystem"'
-    }
-  },
-  head: [
-    ['meta', { name: 'theme-color', content: '#3eaf7c' }],
-    ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
-    ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }]
-  ],
-  theme: 'default-prefers-color-scheme',
-  themeConfig: {
-    repo: '',
-    editLinks: false,
-    docsDir: '',
-    editLinkText: '',
-    lastUpdated: false,
-    locales: {
-      '/': {
-        selectText: 'Sprachen',
-        label: 'Deutsch (German)',
-        nav: [
-          {
-            text: 'Für Nutzer',
-            link: '/users/',
-          },
-          {
-            text: 'Für Admins',
-            link: '/admins/'
-          },
-          {
-            text: 'Über den Selfservice',
-            link: '/selfservice/'
-          },
-          {
-            text: 'Scannerstationen',
-            link: '/scanstations/'
-          },
-          {
-            text: 'Beamershow',
-            link: '/beamershow/'
-          },
-          {
-            text: 'Source Code',
-            link: 'https://git.odit.services/lfk'
-          }
-        ],
-        sidebar: {
-          '/users/': [
-            {
-              title: 'Nutzerdokumentation',
-              collapsable: false,
-              children: [
-                '',
-                'accounts',
-                'organizations',
-                'teams',
-                'runners',
-                'runner_import',
-                'donors',
-                'donations',
-                'cards',
-                'sponsoring_contracts',
-                'tracks',
-                'scans',
-                'scanstations'
-              ]
-            }
-          ],
-          '/admins/': [
-            {
-              title: 'Administrative Dokumentation',
-              collapsable: false,
-              children: [
-                '',
-                'quickstart',
-                'users',
-                'usergroups'
-              ]
-            }
-          ],
-          '/selfservice/': [
-            {
-              title: 'Selfservice Dokumentation',
-              collapsable: false,
-              children: [
-                '',
-                'org_selfservice'
-              ]
-            }
-          ],
-          '/scanstations/': [
-            {
-              title: 'Scannerstation Dokumentation',
-              collapsable: false,
-              children: [
-                '',
-                'install',
-                'config',
-                'config_scanners',
-                'hardware'
-              ]
-            }
-          ],
-          '/beamershow/': [
-            {
-              title: 'Beamershow Dokumentation',
-              collapsable: false,
-              children: [
-                '',
-                'config'
-              ]
-            }
-          ],
-        }
-      },
-      '/en/': {
-        selectText: 'Languages',
-        label: 'English',
-        nav: [
-          {
-            text: 'For Users',
-            link: '/en/users/',
-          },
-          {
-            text: 'For Admins',
-            link: '/en/admins/'
-          },
-          {
-            text: 'Source Code',
-            link: 'https://git.odit.services/lfk'
-          }
-        ],
-        sidebar: {
-          '/en/users/': [
-            {
-              title: 'User documentation',
-              collapsable: false,
-              children: [
-                ''
-              ]
-            }
-          ],
-          '/en/admins/': [
-            {
-              title: 'Admin documentation',
-              collapsable: false,
-              children: [
-                ''
-              ]
-            }
-          ],
-        }
-      }
-    }
-  },
-  plugins: [
-    '@vuepress/plugin-back-to-top',
-    '@vuepress/plugin-medium-zoom',
-    'flexsearch'
-  ]
-}

src/.vuepress/enhanceApp.js

@@ -1,14 +0,0 @@
-/**
- * Client app enhancement file.
- *
- * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
- */
-
-export default ({
-  Vue, // the version of Vue being used in the VuePress app
-  options, // the options for the root Vue instance
-  router, // the router instance for the app
-  siteData // site metadata
-}) => {
-  // ...apply enhancements for the site.
-}

src/.vuepress/styles/index.styl

@@ -1,8 +0,0 @@
-/**
- * Custom Styles here.
- *
- * ref：https://v1.vuepress.vuejs.org/config/#index-styl
- */
-
-.home .hero img
-  max-width 450px!important

src/.vuepress/styles/palette.styl

@@ -1,10 +0,0 @@
-/**
- * Custom palette here.
- *
- * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
- */
-
-$accentColor = #3eaf7c
-$textColor = #2c3e50
-$borderColor = #eaecef
-$codeBgColor = #282c34

src/components/HomepageFeatures/styles.module.css

@@ -0,0 +1,11 @@
+.features {
+  display: flex;
+  align-items: center;
+  padding: 2rem 0;
+  width: 100%;
+}
+
+.featureSvg {
+  height: 200px;
+  width: 200px;
+}

src/css/custom.css

@@ -0,0 +1,30 @@
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+:root {
+  --ifm-color-primary: #2e8555;
+  --ifm-color-primary-dark: #29784c;
+  --ifm-color-primary-darker: #277148;
+  --ifm-color-primary-darkest: #205d3b;
+  --ifm-color-primary-light: #33925d;
+  --ifm-color-primary-lighter: #359962;
+  --ifm-color-primary-lightest: #3cad6e;
+  --ifm-code-font-size: 95%;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+}
+
+/* For readability concerns, you should choose a lighter palette in dark mode. */
+[data-theme='dark'] {
+  --ifm-color-primary: #25c2a0;
+  --ifm-color-primary-dark: #21af90;
+  --ifm-color-primary-darker: #1fa588;
+  --ifm-color-primary-darkest: #1a8870;
+  --ifm-color-primary-light: #29d5b0;
+  --ifm-color-primary-lighter: #32d8b4;
+  --ifm-color-primary-lightest: #4fddbf;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+}

src/en/admins/README.md

@@ -1,3 +0,0 @@
-# Admins
-
-TODO:

src/en/index.md

@@ -1,15 +0,0 @@
----
-home: true
-heroImage: /logo.png
-tagline: The documentation for the LfK! "Läufersystem".
-actionText: Quickstart for users →
-actionLink: ./users/
-# features:
-# - title: Feature 1 Title
-#   details: Feature 1 Description
-# - title: Feature 2 Title
-#   details: Feature 2 Description
-# - title: Feature 3 Title
-#   details: Feature 3 Description
-footer: Made by ODIT.Services with ❤️
----

src/en/users/README.md

@@ -1,11 +0,0 @@
-# Introduction
-
-This part of the documentation describes the interaction with the system for normal users.
-If you're interested in installing, configuring or administrating the system take a look at the <router-link to="../admins">admins section</router-link>.
-
-## FAQ
-> A couple of frequently asked questiones.
-
-### Why can't i see the page XY?
-Users can only see pages if they have the right permissions.
-If you can't view a page that you need to, please contact your administrator.

src/index.md

@@ -1,15 +0,0 @@
----
-home: true
-heroImage: /logo.png
-tagline: Die Dokumentation für das LfK! Läufersystem
-actionText: Schnellstart für Nutzer →
-actionLink: /users/
-# features:
-# - title: Feature 1 Title
-#   details: Feature 1 Description
-# - title: Feature 2 Title
-#   details: Feature 2 Description
-# - title: Feature 3 Title
-#   details: Feature 3 Description
-footer: Made by ODIT.Services with ❤️
----

src/pages/index.js

@@ -0,0 +1,31 @@
+import clsx from 'clsx';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import Layout from '@theme/Layout';
+
+import Heading from '@theme/Heading';
+import styles from './index.module.css';
+
+function HomepageHeader() {
+  const {siteConfig} = useDocusaurusContext();
+  return (
+    <header className={clsx('hero hero--primary', styles.heroBanner)}>
+      <div className="container">
+        <Heading as="h1" className="hero__title">
+          {siteConfig.title}
+        </Heading>
+        <p className="hero__subtitle">{siteConfig.tagline}</p>
+      </div>
+    </header>
+  );
+}
+
+export default function Home() {
+  const {siteConfig} = useDocusaurusContext();
+  return (
+    <Layout
+      title={`Hello from ${siteConfig.title}`}
+      description="Description will go into a meta tag in <head />">
+      <HomepageHeader />
+    </Layout>
+  );
+}

src/pages/index.module.css

@@ -0,0 +1,23 @@
+/**
+ * CSS files with the .module.css suffix will be treated as CSS modules
+ * and scoped locally.
+ */
+
+.heroBanner {
+  padding: 4rem 0;
+  text-align: center;
+  position: relative;
+  overflow: hidden;
+}
+
+@media screen and (max-width: 996px) {
+  .heroBanner {
+    padding: 2rem;
+  }
+}
+
+.buttons {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}

src/pages/markdown-page.md

@@ -0,0 +1,7 @@
+---
+title: Markdown page example
+---
+
+# Markdown page example
+
+You don't need React to write simple standalone pages.