docs: Init

config.yaml

@@ -0,0 +1,121 @@
+# Configuration
+baseURL: "https://docs.lauf-fuer-kaya.de"
+title: "LfK! Dokumentation"
+
+module:
+  imports:
+    - path: github.com/imfing/hextra
+
+enableRobotsTXT: true
+enableGitInfo: true
+hasCJKLanguage: true
+
+outputs:
+  home: [HTML]
+  page: [HTML]
+  section: [HTML, RSS]
+
+markup:
+  highlight:
+    noClasses: false
+  goldmark:
+    renderer:
+      unsafe: true
+    extensions:
+      passthrough:
+        delimiters:
+          block: [['\[', '\]'], ['$$', '$$']]
+          inline: [['\(', '\)']]
+        enable: true
+
+enableInlineShortcodes: true
+
+defaultContentLanguage: de
+languages:
+  de:
+    languageName: Deutsch
+    languageCode: de
+    title: LfK! Dokumentation
+    weight: 1
+  en:
+    languageName: English
+    languageCode: en
+    title: LfK! Documentation
+    weight: 2
+
+menu:
+  main:
+    - identifier: user
+      name: Anwender
+      pageRef: /user
+      weight: 1
+    - identifier: admin
+      name: Administratoren
+      pageRef: /admin
+      weight: 2
+    - identifier: selfservice
+      name: Selfservice
+      pageRef: /selfservice
+      weight: 3
+    - identifier: scanstation
+      name: Scanerstationen
+      pageRef: /scanstation
+      weight: 4
+    - identifier: beamershow
+      name: Beamershow
+      pageRef: /beamershow
+      weight: 5
+    - name: Suche
+      identifier: search
+      weight: 6
+      params:
+        type: search
+
+  sidebar:
+    - identifier: more
+      name: Mehr
+      params:
+        type: separator
+      weight: 1
+    - identifier: source
+      name: "Source Code"
+      url: "https://git.odit.services/lfk"
+      weight: 2
+
+params:
+  description: Dokumentation für das Lauf für Kaya! Läufersystem.
+
+  navbar:
+    displayTitle: true
+    displayLogo: true
+    logo:
+      path: logo.png
+      dark: logo.png
+      # width: 40
+      # height: 20
+      # link: /
+    width: wide
+  theme:
+    default: system
+    displayToggle: true
+  footer:
+    enable: true
+    displayCopyright: false
+    displayPoweredBy: false
+    width: normal
+  search:
+    enable: true
+    type: flexsearch
+
+    flexsearch:
+      # index page by: content | summary | heading | title
+      index: content
+      # full | forward | reverse | strict
+      # https://github.com/nextapps-de/flexsearch/#tokenizer-prefix-search
+      tokenize: forward
+  highlight:
+    copy:
+      enable: true
+      display: hover
+  comments:
+    enable: false

content/_index.de.md

@@ -0,0 +1,25 @@
+---
+title: Die Dokumentation für das LfK! Läufersystem
+layout: hextra-home
+---
+{{< hextra/hero-badge >}}
+  <div class="hx-w-2 hx-h-2 hx-rounded-full hx-bg-primary-400"></div>
+  <span>Kostenlos, open source</span>
+  {{< icon name="arrow-circle-right" attributes="height=14" >}}
+{{< /hextra/hero-badge >}}
+
+<div class="hx-mt-6 hx-mb-6">
+{{< hextra/hero-headline >}}
+  Dokumentation des LfK! Läufersystems.
+{{< /hextra/hero-headline >}}
+</div>
+
+<div class="hx-mb-12">
+{{< hextra/hero-subtitle >}}
+  Hier findest du alle Informationen, die du benötigst, um das LfK! Läufersystem zu installieren, zu konfigurieren und zu nutzen.
+{{< /hextra/hero-subtitle >}}
+</div>
+
+<div class="hx-mb-6">
+{{< hextra/hero-button text="Schnellstart für Nutzer 👉" link="user" >}}
+</div>

content/_index.en.md

@@ -0,0 +1,25 @@
+---
+title: The Documentation for the LfK! Runner System
+layout: hextra-home
+---
+{{< hextra/hero-badge >}}
+  <div class="hx-w-2 hx-h-2 hx-rounded-full hx-bg-primary-400"></div>
+  <span>Free, open source</span>
+  {{< icon name="arrow-circle-right" attributes="height=14" >}}
+{{< /hextra/hero-badge >}}
+
+<div class="hx-mt-6 hx-mb-6">
+{{< hextra/hero-headline >}}
+  Documentation of the LfK! Runner System.
+{{< /hextra/hero-headline >}}
+</div>
+
+<div class="hx-mb-12">
+{{< hextra/hero-subtitle >}}
+  Here you will find all the information you need to install, configure, and use the LfK! Runner System.
+{{< /hextra/hero-subtitle >}}
+</div>
+
+<div class="hx-mb-6">
+{{< hextra/hero-button text="Quickstart for Users 👉" link="user" >}}
+</div>

content/user/_index.de.md

@@ -0,0 +1,13 @@
+---
+linkTitle: "Nutzerdokumentation"
+title: Einleitung
+---
+Dieser Teil der Dokumentation befasst sich mit der Bedienung des Läufersystems für normale Nutzer:innen.
+Solltest du an der Installation oder Konfiguration interessiert sein schau doch mal in den [Admin](/admins) Bereich.
+
+## FAQ
+> Ein paar der meist gestellten Fragen vorab
+
+### Warum sehe ich eine Seite nicht?
+Nutzer sehen nur die Seiten im System, für die sie Berechtigungen haben.
+Solltest du eine Seite nicht sehen, die du brauchst melde dich bitte bei deinem Admin.

go.mod

@@ -0,0 +1,5 @@
+module git.odit.services/lfk/docs
+
+go 1.23.4
+
+require github.com/imfing/hextra v0.9.3 // indirect

go.sum

@@ -0,0 +1,2 @@
+github.com/imfing/hextra v0.9.3 h1:p4vDm2TSgt3RpJdJm2mqkpoJCH2S08wzySyyYodtgCc=
+github.com/imfing/hextra v0.9.3/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI=

i18n/en.yaml

@@ -0,0 +1,6 @@
+user: User
+admin: Administrators
+selfservice: Selfservice
+scanstation: Scaning Stations
+beamershow: Beamer Show
+search: Search

layouts/partials/custom/footer.html

@@ -0,0 +1,4 @@
+<div style="text-align: center; width: 100%;"></div>
+    Made by <a href="https://odit.services/?ref=lfk-docs" target="_blank" rel="noreferrer">ODIT.Services</a> with ❤️ <br>
+    Developed for <a href="https://lauf-fuer-kaya.de" target="_blank" rel="noreferrer">Lauf für Kaya</a> | <a href="https://lauf-fuer-kaya.de/impressum" target="_blank" rel="noreferrer">Imprint</a> | <a href="https://lauf-fuer-kaya.de/datenschutz" target="_blank" rel="noreferrer">Privacy</a>
+</div>

static/files/class_with_middlename.csv

@@ -0,0 +1,11 @@
+Vorname;Mittelname;Nachname;Klasse
+Lorem ;Impum;dolor;1A
+sit;;amet;1A
+consetetur;sadipscing;elitr;1A
+Max;;Mustermann;1A
+Maxime;;Mustermann;2A
+Peter;Emanuel ;Lustig;2A
+Robert;;Schmidtt;2A
+Guten;;Morgen;2A
+Wunderschönen;Guten;Morgen;3A
+Tolle;;Ümläütä;3A

static/files/class_without_middlename.csv

@@ -0,0 +1,11 @@
+Vorname;Nachname;Klasse
+Lorem ;dolor;1A
+sit;amet;1A
+consetetur;elitr;1A
+Max;Mustermann;1A
+Maxime;Mustermann;2A
+Peter;Lustig;2A
+Robert;Schmidtt;2A
+Guten;Morgen;2A
+Wunderschönen;Morgen;3A
+Tolle;Ümläütä;3A