diff --git a/config.yaml b/config.yaml new file mode 100644 index 0000000..07863e7 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/content/_index.de.md b/content/_index.de.md new file mode 100644 index 0000000..40ec506 --- /dev/null +++ b/content/_index.de.md @@ -0,0 +1,25 @@ +--- +title: Die Dokumentation für das LfK! Läufersystem +layout: hextra-home +--- +{{< hextra/hero-badge >}} +
+ Kostenlos, open source + {{< icon name="arrow-circle-right" attributes="height=14" >}} +{{< /hextra/hero-badge >}} + +
+{{< hextra/hero-headline >}} + Dokumentation des LfK! Läufersystems. +{{< /hextra/hero-headline >}} +
+ +
+{{< 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 >}} +
+ +
+{{< hextra/hero-button text="Schnellstart für Nutzer 👉" link="user" >}} +
\ No newline at end of file diff --git a/content/_index.en.md b/content/_index.en.md new file mode 100644 index 0000000..f07f9bb --- /dev/null +++ b/content/_index.en.md @@ -0,0 +1,25 @@ +--- +title: The Documentation for the LfK! Runner System +layout: hextra-home +--- +{{< hextra/hero-badge >}} +
+ Free, open source + {{< icon name="arrow-circle-right" attributes="height=14" >}} +{{< /hextra/hero-badge >}} + +
+{{< hextra/hero-headline >}} + Documentation of the LfK! Runner System. +{{< /hextra/hero-headline >}} +
+ +
+{{< hextra/hero-subtitle >}} + Here you will find all the information you need to install, configure, and use the LfK! Runner System. +{{< /hextra/hero-subtitle >}} +
+ +
+{{< hextra/hero-button text="Quickstart for Users 👉" link="user" >}} +
\ No newline at end of file diff --git a/content/user/_index.de.md b/content/user/_index.de.md new file mode 100644 index 0000000..3107ea4 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..21b5ed8 --- /dev/null +++ b/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 diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..08708c9 --- /dev/null +++ b/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= diff --git a/i18n/en.yaml b/i18n/en.yaml new file mode 100644 index 0000000..d92d70f --- /dev/null +++ b/i18n/en.yaml @@ -0,0 +1,6 @@ +user: User +admin: Administrators +selfservice: Selfservice +scanstation: Scaning Stations +beamershow: Beamer Show +search: Search \ No newline at end of file diff --git a/layouts/partials/custom/footer.html b/layouts/partials/custom/footer.html new file mode 100644 index 0000000..01e498a --- /dev/null +++ b/layouts/partials/custom/footer.html @@ -0,0 +1,4 @@ +
+ Made by ODIT.Services with ❤️
+ Developed for Lauf für Kaya | Imprint | Privacy + \ No newline at end of file diff --git a/static/files/class_with_middlename.csv b/static/files/class_with_middlename.csv new file mode 100644 index 0000000..10e86d0 --- /dev/null +++ b/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 diff --git a/static/files/class_with_middlename.xlsx b/static/files/class_with_middlename.xlsx new file mode 100644 index 0000000..4270d40 Binary files /dev/null and b/static/files/class_with_middlename.xlsx differ diff --git a/static/files/class_without_middlename.csv b/static/files/class_without_middlename.csv new file mode 100644 index 0000000..41090b3 --- /dev/null +++ b/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 diff --git a/static/files/class_without_middlename.xlsx b/static/files/class_without_middlename.xlsx new file mode 100644 index 0000000..abb2c72 Binary files /dev/null and b/static/files/class_without_middlename.xlsx differ diff --git a/static/files/scannerconfig.docx b/static/files/scannerconfig.docx new file mode 100644 index 0000000..2d55098 Binary files /dev/null and b/static/files/scannerconfig.docx differ diff --git a/static/files/scannerconfig.pdf b/static/files/scannerconfig.pdf new file mode 100644 index 0000000..611d499 Binary files /dev/null and b/static/files/scannerconfig.pdf differ diff --git a/static/images/barcode_config/00_factory_reset.png b/static/images/barcode_config/00_factory_reset.png new file mode 100644 index 0000000..712e94d Binary files /dev/null and b/static/images/barcode_config/00_factory_reset.png differ diff --git a/static/images/barcode_config/01_programming-mode.png b/static/images/barcode_config/01_programming-mode.png new file mode 100644 index 0000000..d2fc6df Binary files /dev/null and b/static/images/barcode_config/01_programming-mode.png differ diff --git a/static/images/barcode_config/02_disable_all.png b/static/images/barcode_config/02_disable_all.png new file mode 100644 index 0000000..80ac953 Binary files /dev/null and b/static/images/barcode_config/02_disable_all.png differ diff --git a/static/images/barcode_config/03_enable_ean.png b/static/images/barcode_config/03_enable_ean.png new file mode 100644 index 0000000..c5569f4 Binary files /dev/null and b/static/images/barcode_config/03_enable_ean.png differ diff --git a/static/images/barcode_config/04_check_ean_digit.png b/static/images/barcode_config/04_check_ean_digit.png new file mode 100644 index 0000000..0ff5ca2 Binary files /dev/null and b/static/images/barcode_config/04_check_ean_digit.png differ diff --git a/static/images/barcode_config/05_disable_ean_digit.png b/static/images/barcode_config/05_disable_ean_digit.png new file mode 100644 index 0000000..81fa818 Binary files /dev/null and b/static/images/barcode_config/05_disable_ean_digit.png differ diff --git a/static/images/barcode_config/06_always_on.png b/static/images/barcode_config/06_always_on.png new file mode 100644 index 0000000..9b74082 Binary files /dev/null and b/static/images/barcode_config/06_always_on.png differ diff --git a/static/images/barcode_config/07_beep_off.png b/static/images/barcode_config/07_beep_off.png new file mode 100644 index 0000000..36af7c3 Binary files /dev/null and b/static/images/barcode_config/07_beep_off.png differ diff --git a/static/images/barcode_config/08_countrycode_germany.png b/static/images/barcode_config/08_countrycode_germany.png new file mode 100644 index 0000000..402963d Binary files /dev/null and b/static/images/barcode_config/08_countrycode_germany.png differ diff --git a/static/images/runner_import_excel_no_middlename.png b/static/images/runner_import_excel_no_middlename.png new file mode 100644 index 0000000..06551e8 Binary files /dev/null and b/static/images/runner_import_excel_no_middlename.png differ diff --git a/static/images/runner_import_excel_with_middlename.png b/static/images/runner_import_excel_with_middlename.png new file mode 100644 index 0000000..59e5119 Binary files /dev/null and b/static/images/runner_import_excel_with_middlename.png differ diff --git a/static/images/service_interaction.png b/static/images/service_interaction.png new file mode 100644 index 0000000..d2fc9f6 Binary files /dev/null and b/static/images/service_interaction.png differ diff --git a/static/logo.png b/static/logo.png new file mode 100644 index 0000000..428d415 Binary files /dev/null and b/static/logo.png differ