From c0ba5008e00153b5dd85b6efdb1e2df578415cb9 Mon Sep 17 00:00:00 2001 From: dsamhabe Date: Mon, 11 Mar 2024 09:25:49 +0100 Subject: [PATCH 01/14] feat(wip): added index page for docs --- docs/.vitepress/config.mts | 13 ++----------- docs/index.md | 19 ++++++------------- 2 files changed, 8 insertions(+), 24 deletions(-) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index c99082e..a003197 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -8,17 +8,8 @@ export default defineConfig({ // https://vitepress.dev/reference/default-theme-config nav: [ { text: 'Home', link: '/' }, - { text: 'Examples', link: '/markdown-examples' } - ], - - sidebar: [ - { - text: 'Examples', - items: [ - { text: 'Markdown Examples', link: '/markdown-examples' }, - { text: 'Runtime API Examples', link: '/api-examples' } - ] - } + { text: 'For Users', link: '/userSection/' }, + { text: 'For Developers', link: '/developerSection/' } ], socialLinks: [ diff --git a/docs/index.md b/docs/index.md index 177ad12..172f1c6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,21 +5,14 @@ layout: home hero: name: "Schulbuchaktion Docs" text: "Official Schulbuchaktion Documentation" - tagline: My great project tagline actions: - - theme: brand - text: Markdown Examples - link: /markdown-examples - - theme: alt - text: API Examples - link: /api-examples features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Get to know the project + details: This site helps both users and developers better understand our project "Schulbuchaktion" + - title: From a user's point of view + details: The page "For Users" is designed to explain users how to use our project for their purposes + - title: From a developer's point of view + details: The page "For Developers" is dedicated to all developers who want to work with our product --- From bf48576b7c2b26187bb1d105e90a7f221a40d08f Mon Sep 17 00:00:00 2001 From: dsamhabe Date: Mon, 11 Mar 2024 09:26:03 +0100 Subject: [PATCH 02/14] feat(wip): added routes for user and devs doc --- docs/developerSection/index.md | 26 ++++++++++++++++++++++++++ docs/userSection/index.md | 25 +++++++++++++++++++++++++ 2 files changed, 51 insertions(+) create mode 100644 docs/developerSection/index.md create mode 100644 docs/userSection/index.md diff --git a/docs/developerSection/index.md b/docs/developerSection/index.md new file mode 100644 index 0000000..9837f7b --- /dev/null +++ b/docs/developerSection/index.md @@ -0,0 +1,26 @@ + +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Schulbuchaktion Docs" + text: "Official Schulbuchaktion Documentation" + tagline: My great project tagline + actions: + - theme: brand + text: Markdown Examples + link: /markdown-examples + - theme: alt + text: API Examples + link: /api-examples + +features: + - title: Feature A + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Feature B + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Feature C + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit +--- + diff --git a/docs/userSection/index.md b/docs/userSection/index.md new file mode 100644 index 0000000..177ad12 --- /dev/null +++ b/docs/userSection/index.md @@ -0,0 +1,25 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Schulbuchaktion Docs" + text: "Official Schulbuchaktion Documentation" + tagline: My great project tagline + actions: + - theme: brand + text: Markdown Examples + link: /markdown-examples + - theme: alt + text: API Examples + link: /api-examples + +features: + - title: Feature A + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Feature B + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Feature C + details: Lorem ipsum dolor sit amet, consectetur adipiscing elit +--- + From 897f8808f76b66093e5611b05a13f3c825236066 Mon Sep 17 00:00:00 2001 From: dsamhabe Date: Mon, 11 Mar 2024 09:40:05 +0100 Subject: [PATCH 03/14] feat(wip): changed text --- docs/index.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 172f1c6..3ef9c79 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,6 @@ layout: home hero: name: "Schulbuchaktion Docs" text: "Official Schulbuchaktion Documentation" - actions: features: - title: Get to know the project From 9834f00237c05fb2a080359f471e1f72f496722e Mon Sep 17 00:00:00 2001 From: dsamhabe Date: Thu, 14 Mar 2024 10:39:55 +0100 Subject: [PATCH 04/14] feat: setup vitepress documentation --- docs/.vitepress/config.mts | 13 ++++++++++--- docs/de/developerSection/index.md | 17 +++++++++++++++++ docs/de/index.md | 17 +++++++++++++++++ docs/de/userSection/index.md | 17 +++++++++++++++++ docs/developerSection/index.md | 21 ++++++--------------- docs/userSection/index.md | 20 ++++++-------------- 6 files changed, 73 insertions(+), 32 deletions(-) create mode 100644 docs/de/developerSection/index.md create mode 100644 docs/de/index.md create mode 100644 docs/de/userSection/index.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index a003197..722c58c 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -8,12 +8,19 @@ export default defineConfig({ // https://vitepress.dev/reference/default-theme-config nav: [ { text: 'Home', link: '/' }, - { text: 'For Users', link: '/userSection/' }, - { text: 'For Developers', link: '/developerSection/' } + { text: 'Users', link: '/userSection/' }, + { text: 'Developers', link: '/developerSection/' }, + { + text: "Language", + items: [ + {text: 'German', link: '/de/'}, + {text: 'English', link: '/'} + ] + } ], socialLinks: [ - { icon: 'github', link: 'https://github.com/vuejs/vitepress' } + { icon: "github", link: 'https://github.com/Dino-Kupinic/Schulbuchaktion.git' }, ] } }) diff --git a/docs/de/developerSection/index.md b/docs/de/developerSection/index.md new file mode 100644 index 0000000..10f9f73 --- /dev/null +++ b/docs/de/developerSection/index.md @@ -0,0 +1,17 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Schulbuchaktion Docs" + text: "Official Schulbuchaktion Documentation" + +features: + - title: Explanation 1 + details: On this page the viewer gets a description on how to work with our projekt + - title: Explanation 2 + details: Add documentation here + - title: Explanation 3 + details: Add documentation here +--- + diff --git a/docs/de/index.md b/docs/de/index.md new file mode 100644 index 0000000..c740acc --- /dev/null +++ b/docs/de/index.md @@ -0,0 +1,17 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Schulbuchaktion Docs" + text: "Official Schulbuchaktion Documentation" + +features: + - title: Description 1 + details: On this page there is a manual on how to use our project + - title: Explanation 1 + details: Lorem ipsum blablabla + - title: Description 2 + details: Lorem ipsum blablabla +--- + diff --git a/docs/de/userSection/index.md b/docs/de/userSection/index.md new file mode 100644 index 0000000..c740acc --- /dev/null +++ b/docs/de/userSection/index.md @@ -0,0 +1,17 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Schulbuchaktion Docs" + text: "Official Schulbuchaktion Documentation" + +features: + - title: Description 1 + details: On this page there is a manual on how to use our project + - title: Explanation 1 + details: Lorem ipsum blablabla + - title: Description 2 + details: Lorem ipsum blablabla +--- + diff --git a/docs/developerSection/index.md b/docs/developerSection/index.md index 9837f7b..10f9f73 100644 --- a/docs/developerSection/index.md +++ b/docs/developerSection/index.md @@ -1,4 +1,3 @@ - --- # https://vitepress.dev/reference/default-theme-home-page layout: home @@ -6,21 +5,13 @@ layout: home hero: name: "Schulbuchaktion Docs" text: "Official Schulbuchaktion Documentation" - tagline: My great project tagline - actions: - - theme: brand - text: Markdown Examples - link: /markdown-examples - - theme: alt - text: API Examples - link: /api-examples features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Explanation 1 + details: On this page the viewer gets a description on how to work with our projekt + - title: Explanation 2 + details: Add documentation here + - title: Explanation 3 + details: Add documentation here --- diff --git a/docs/userSection/index.md b/docs/userSection/index.md index 177ad12..c740acc 100644 --- a/docs/userSection/index.md +++ b/docs/userSection/index.md @@ -5,21 +5,13 @@ layout: home hero: name: "Schulbuchaktion Docs" text: "Official Schulbuchaktion Documentation" - tagline: My great project tagline - actions: - - theme: brand - text: Markdown Examples - link: /markdown-examples - - theme: alt - text: API Examples - link: /api-examples features: - - title: Feature A - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature B - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - - title: Feature C - details: Lorem ipsum dolor sit amet, consectetur adipiscing elit + - title: Description 1 + details: On this page there is a manual on how to use our project + - title: Explanation 1 + details: Lorem ipsum blablabla + - title: Description 2 + details: Lorem ipsum blablabla --- From 0b97993743e9975fb54a0be6e5f29507016a4949 Mon Sep 17 00:00:00 2001 From: dsamhabe Date: Thu, 14 Mar 2024 11:26:54 +0100 Subject: [PATCH 05/14] feat: translate base sites to german, feat(wip): add dynamic routing --- docs/.vitepress/config.mts | 14 +++++++++----- docs/developerSection/index.md | 17 ----------------- docs/packages/de/developerSection/index.md | 17 +++++++++++++++++ docs/packages/de/indexGerman.md | 17 +++++++++++++++++ docs/{ => packages}/de/userSection/index.md | 8 ++++---- .../en}/developerSection/index.md | 0 docs/{index.md => packages/en/indexEnglish.md} | 0 docs/{de => packages/en/userSection}/index.md | 0 docs/userSection/index.md | 17 ----------------- 9 files changed, 47 insertions(+), 43 deletions(-) delete mode 100644 docs/developerSection/index.md create mode 100644 docs/packages/de/developerSection/index.md create mode 100644 docs/packages/de/indexGerman.md rename docs/{ => packages}/de/userSection/index.md (59%) rename docs/{de => packages/en}/developerSection/index.md (100%) rename docs/{index.md => packages/en/indexEnglish.md} (100%) rename docs/{de => packages/en/userSection}/index.md (100%) delete mode 100644 docs/userSection/index.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 722c58c..4d5ae4d 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -2,21 +2,25 @@ import { defineConfig } from 'vitepress' // https://vitepress.dev/reference/site-config export default defineConfig({ + rewrites: { + 'packages/de/index.md': 'de/indexGerman.md', + 'packages/en/index.md': 'en/indexGerman.md', + }, title: "Schulbuchaktion Docs", description: "Official Schulbuchaktion Documentation", themeConfig: { // https://vitepress.dev/reference/default-theme-config nav: [ - { text: 'Home', link: '/' }, - { text: 'Users', link: '/userSection/' }, - { text: 'Developers', link: '/developerSection/' }, + { text: 'Home', link: '/en/' }, + { text: 'Users', link: 'userSection/'}, + { text: 'Developers', link: 'developerSection/'}, { text: "Language", items: [ {text: 'German', link: '/de/'}, - {text: 'English', link: '/'} + {text: 'English', link: '/en/'} ] - } + }, ], socialLinks: [ diff --git a/docs/developerSection/index.md b/docs/developerSection/index.md deleted file mode 100644 index 10f9f73..0000000 --- a/docs/developerSection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Docs" - text: "Official Schulbuchaktion Documentation" - -features: - - title: Explanation 1 - details: On this page the viewer gets a description on how to work with our projekt - - title: Explanation 2 - details: Add documentation here - - title: Explanation 3 - details: Add documentation here ---- - diff --git a/docs/packages/de/developerSection/index.md b/docs/packages/de/developerSection/index.md new file mode 100644 index 0000000..ba998cc --- /dev/null +++ b/docs/packages/de/developerSection/index.md @@ -0,0 +1,17 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Schulbuchaktion Doku" + text: "Offizielle Schulbuchaktion Dokumentation" + +features: + - title: Erklärung 1 + details: Auf dieser Seite erhält der Betrachter eine Beschreibung, wie er mit unserem Projekt arbeiten kann + - title: Erklärung 2 + details: Dokumentation hier einfügen + - title: Erklärung 3 + details: Dokumentation hier einfügen +--- + diff --git a/docs/packages/de/indexGerman.md b/docs/packages/de/indexGerman.md new file mode 100644 index 0000000..a6d5115 --- /dev/null +++ b/docs/packages/de/indexGerman.md @@ -0,0 +1,17 @@ +--- +# https://vitepress.dev/reference/default-theme-home-page +layout: home + +hero: + name: "Schulbuchaktion Doku" + text: "Offizielle Schulbuchaktion Dokumentation" + +features: + - title: Lernen Sie das Projekt kennen + details: Diese Seite hilf sowohl Nutzern als auch Entwicklern unser Projekt "Schulbuchaktion" besser zu verstehen. + - title: Aus Sicht eines Benutzers + details: Die Seite "Für Benutzer" soll den Benutzern erklären, wie sie unser Projekt für ihre Zwecke nutzen können. + - title: Aus Sicht eines Entwicklers + details: Die Seite "Für Entwickler" ist für alle Entwickler gedacht, die mit unserem Produkt arbeiten möchten. +--- + diff --git a/docs/de/userSection/index.md b/docs/packages/de/userSection/index.md similarity index 59% rename from docs/de/userSection/index.md rename to docs/packages/de/userSection/index.md index c740acc..3593ccd 100644 --- a/docs/de/userSection/index.md +++ b/docs/packages/de/userSection/index.md @@ -7,11 +7,11 @@ hero: text: "Official Schulbuchaktion Documentation" features: - - title: Description 1 - details: On this page there is a manual on how to use our project - - title: Explanation 1 + - title: Beschreibung 1 + details: Auf dieser Seite finden Sie eine Anleitung, wie Sie unser Projekt nutzen können + - title: Erklärung 1 details: Lorem ipsum blablabla - - title: Description 2 + - title: Beschreibung 2 details: Lorem ipsum blablabla --- diff --git a/docs/de/developerSection/index.md b/docs/packages/en/developerSection/index.md similarity index 100% rename from docs/de/developerSection/index.md rename to docs/packages/en/developerSection/index.md diff --git a/docs/index.md b/docs/packages/en/indexEnglish.md similarity index 100% rename from docs/index.md rename to docs/packages/en/indexEnglish.md diff --git a/docs/de/index.md b/docs/packages/en/userSection/index.md similarity index 100% rename from docs/de/index.md rename to docs/packages/en/userSection/index.md diff --git a/docs/userSection/index.md b/docs/userSection/index.md deleted file mode 100644 index c740acc..0000000 --- a/docs/userSection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Docs" - text: "Official Schulbuchaktion Documentation" - -features: - - title: Description 1 - details: On this page there is a manual on how to use our project - - title: Explanation 1 - details: Lorem ipsum blablabla - - title: Description 2 - details: Lorem ipsum blablabla ---- - From 22ccb5f758b5ab40f13c491fbfca14b2f1d4f7ba Mon Sep 17 00:00:00 2001 From: dsamhabe Date: Thu, 14 Mar 2024 11:44:21 +0100 Subject: [PATCH 06/14] feat(wip): dynamic routing --- docs/.vitepress/config.mts | 4 +-- docs/packages/de/configGerman.ts | 30 +++++++++++++++++++ docs/packages/de/{indexGerman.md => index.md} | 0 .../packages/en/{indexEnglish.md => index.md} | 0 4 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 docs/packages/de/configGerman.ts rename docs/packages/de/{indexGerman.md => index.md} (100%) rename docs/packages/en/{indexEnglish.md => index.md} (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 4d5ae4d..9abaab7 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -3,8 +3,8 @@ import { defineConfig } from 'vitepress' // https://vitepress.dev/reference/site-config export default defineConfig({ rewrites: { - 'packages/de/index.md': 'de/indexGerman.md', - 'packages/en/index.md': 'en/indexGerman.md', + 'packages/:pkg/(.*)': ':pkg/index.md', + '/': '/en/' }, title: "Schulbuchaktion Docs", description: "Official Schulbuchaktion Documentation", diff --git a/docs/packages/de/configGerman.ts b/docs/packages/de/configGerman.ts new file mode 100644 index 0000000..b1856b6 --- /dev/null +++ b/docs/packages/de/configGerman.ts @@ -0,0 +1,30 @@ +import { defineConfig } from 'vitepress' + +// https://vitepress.dev/reference/site-config +export default defineConfig({ + rewrites: { + 'packages/:pkg/(.*)': ':pkg/index.md', + '/': '/en/' + }, + title: "Schulbuchaktion Docs", + description: "Official Schulbuchaktion Documentation", + themeConfig: { + // https://vitepress.dev/reference/default-theme-config + nav: [ + { text: 'Home', link: '/en/' }, + { text: 'Users', link: 'userSection/'}, + { text: 'Developers', link: 'developerSection/'}, + { + text: "Language", + items: [ + {text: 'German', link: '/de/'}, + {text: 'English', link: '/en/'} + ] + }, + ], + + socialLinks: [ + { icon: "github", link: 'https://github.com/Dino-Kupinic/Schulbuchaktion.git' }, + ] + } +}) diff --git a/docs/packages/de/indexGerman.md b/docs/packages/de/index.md similarity index 100% rename from docs/packages/de/indexGerman.md rename to docs/packages/de/index.md diff --git a/docs/packages/en/indexEnglish.md b/docs/packages/en/index.md similarity index 100% rename from docs/packages/en/indexEnglish.md rename to docs/packages/en/index.md From b22b0bd55ac4b2b3cf02c7d7b2cd0a92594db543 Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Thu, 14 Mar 2024 22:56:08 +0100 Subject: [PATCH 07/14] feat(wip): update home page --- docs/.vitepress/config.ts | 35 +++++++++++++++++++ docs/getting-started | 0 docs/index.md | 73 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 108 insertions(+) create mode 100644 docs/.vitepress/config.ts create mode 100644 docs/getting-started create mode 100644 docs/index.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts new file mode 100644 index 0000000..af75699 --- /dev/null +++ b/docs/.vitepress/config.ts @@ -0,0 +1,35 @@ +import {defineConfig} from "vitepress" + +export default defineConfig({ + title: "Schulbuchaktion", + description: "Official Schulbuchaktion Documentation", + themeConfig: { + nav: [ + {text: "Home", link: "/"}, + {text: "Users", link: "userSection/"}, + {text: "Developers", link: "developerSection/"}, + ], + logo: {src: "/assets/htl-logo.svg"}, + socialLinks: [ + {icon: "github", link: "https://github.com/Dino-Kupinic/Schulbuchaktion.git"}, + ], + search: { + provider: "local", + }, + footer: { + message: "Released under the MIT License.", + copyright: "Copyright © 2024-present Nixx Labs", + }, + }, + locales: { + root: { + label: "English", + lang: "en", + }, + de: { + label: "Deutsch", + lang: "de", + link: "/de/", + }, + }, +}) diff --git a/docs/getting-started b/docs/getting-started new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..71ea3f4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,73 @@ +--- +layout: home + +title: Schulbuchaktion +titleTemplate: The easiest way of managing school books + +hero: + name: "Schulbuchaktion" + text: "Documentation" + tagline: 📚 Easily manage school books + actions: + - theme: brand + text: Quickstart for Users + link: /guide/getting-started + - theme: alt + text: Developer Reference + link: https://github.com/vuejs/vitepress + image: + src: assets/htl-logo.svg + alt: VitePress + + +features: + - icon: 📑 + title: Order List + details: Simple book ordering, manage classes efficiently. + - icon: 👩‍👧‍👦 + title: Class Management + details: Streamlined student and class administration. + - icon: 💵 + title: Budget Overview + details: Analyze budget effectively for informed decisions. + - icon: 💡 + title: Import + details: Import XLSX files effortlessly for accurate data. + - icon: 🎨 + title: Customizable + details: Personalize colors, themes, and language settings. + - icon: 🔐 + title: Secure + details: We ensure data security with robust measures. + - icon: 🚀 + title: Performant + details: Experience fast, responsive performance for seamless operations. +--- + + + From defd3d72041dfcd2d966078916a3afdea1d29bf6 Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Thu, 14 Mar 2024 22:56:47 +0100 Subject: [PATCH 08/14] fix: delete unnecessary stuff --- docs/.vitepress/config.mts | 30 -------- docs/api-examples.md | 49 ------------- docs/markdown-examples.md | 85 ---------------------- docs/packages/de/configGerman.ts | 30 -------- docs/packages/de/developerSection/index.md | 17 ----- docs/packages/de/index.md | 17 ----- docs/packages/de/userSection/index.md | 17 ----- docs/packages/en/developerSection/index.md | 17 ----- docs/packages/en/index.md | 17 ----- docs/packages/en/userSection/index.md | 17 ----- 10 files changed, 296 deletions(-) delete mode 100644 docs/.vitepress/config.mts delete mode 100644 docs/api-examples.md delete mode 100644 docs/markdown-examples.md delete mode 100644 docs/packages/de/configGerman.ts delete mode 100644 docs/packages/de/developerSection/index.md delete mode 100644 docs/packages/de/index.md delete mode 100644 docs/packages/de/userSection/index.md delete mode 100644 docs/packages/en/developerSection/index.md delete mode 100644 docs/packages/en/index.md delete mode 100644 docs/packages/en/userSection/index.md diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts deleted file mode 100644 index 9abaab7..0000000 --- a/docs/.vitepress/config.mts +++ /dev/null @@ -1,30 +0,0 @@ -import { defineConfig } from 'vitepress' - -// https://vitepress.dev/reference/site-config -export default defineConfig({ - rewrites: { - 'packages/:pkg/(.*)': ':pkg/index.md', - '/': '/en/' - }, - title: "Schulbuchaktion Docs", - description: "Official Schulbuchaktion Documentation", - themeConfig: { - // https://vitepress.dev/reference/default-theme-config - nav: [ - { text: 'Home', link: '/en/' }, - { text: 'Users', link: 'userSection/'}, - { text: 'Developers', link: 'developerSection/'}, - { - text: "Language", - items: [ - {text: 'German', link: '/de/'}, - {text: 'English', link: '/en/'} - ] - }, - ], - - socialLinks: [ - { icon: "github", link: 'https://github.com/Dino-Kupinic/Schulbuchaktion.git' }, - ] - } -}) diff --git a/docs/api-examples.md b/docs/api-examples.md deleted file mode 100644 index 6bd8bb5..0000000 --- a/docs/api-examples.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -outline: deep ---- - -# Runtime API Examples - -This page demonstrates usage of some of the runtime APIs provided by VitePress. - -The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: - -```md - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
-``` - - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
- -## More - -Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/docs/markdown-examples.md b/docs/markdown-examples.md deleted file mode 100644 index f9258a5..0000000 --- a/docs/markdown-examples.md +++ /dev/null @@ -1,85 +0,0 @@ -# Markdown Extension Examples - -This page demonstrates some of the built-in markdown extensions provided by VitePress. - -## Syntax Highlighting - -VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting: - -**Input** - -````md -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` -```` - -**Output** - -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` - -## Custom Containers - -**Input** - -```md -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: -``` - -**Output** - -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: - -## More - -Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). diff --git a/docs/packages/de/configGerman.ts b/docs/packages/de/configGerman.ts deleted file mode 100644 index b1856b6..0000000 --- a/docs/packages/de/configGerman.ts +++ /dev/null @@ -1,30 +0,0 @@ -import { defineConfig } from 'vitepress' - -// https://vitepress.dev/reference/site-config -export default defineConfig({ - rewrites: { - 'packages/:pkg/(.*)': ':pkg/index.md', - '/': '/en/' - }, - title: "Schulbuchaktion Docs", - description: "Official Schulbuchaktion Documentation", - themeConfig: { - // https://vitepress.dev/reference/default-theme-config - nav: [ - { text: 'Home', link: '/en/' }, - { text: 'Users', link: 'userSection/'}, - { text: 'Developers', link: 'developerSection/'}, - { - text: "Language", - items: [ - {text: 'German', link: '/de/'}, - {text: 'English', link: '/en/'} - ] - }, - ], - - socialLinks: [ - { icon: "github", link: 'https://github.com/Dino-Kupinic/Schulbuchaktion.git' }, - ] - } -}) diff --git a/docs/packages/de/developerSection/index.md b/docs/packages/de/developerSection/index.md deleted file mode 100644 index ba998cc..0000000 --- a/docs/packages/de/developerSection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Doku" - text: "Offizielle Schulbuchaktion Dokumentation" - -features: - - title: Erklärung 1 - details: Auf dieser Seite erhält der Betrachter eine Beschreibung, wie er mit unserem Projekt arbeiten kann - - title: Erklärung 2 - details: Dokumentation hier einfügen - - title: Erklärung 3 - details: Dokumentation hier einfügen ---- - diff --git a/docs/packages/de/index.md b/docs/packages/de/index.md deleted file mode 100644 index a6d5115..0000000 --- a/docs/packages/de/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Doku" - text: "Offizielle Schulbuchaktion Dokumentation" - -features: - - title: Lernen Sie das Projekt kennen - details: Diese Seite hilf sowohl Nutzern als auch Entwicklern unser Projekt "Schulbuchaktion" besser zu verstehen. - - title: Aus Sicht eines Benutzers - details: Die Seite "Für Benutzer" soll den Benutzern erklären, wie sie unser Projekt für ihre Zwecke nutzen können. - - title: Aus Sicht eines Entwicklers - details: Die Seite "Für Entwickler" ist für alle Entwickler gedacht, die mit unserem Produkt arbeiten möchten. ---- - diff --git a/docs/packages/de/userSection/index.md b/docs/packages/de/userSection/index.md deleted file mode 100644 index 3593ccd..0000000 --- a/docs/packages/de/userSection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Docs" - text: "Official Schulbuchaktion Documentation" - -features: - - title: Beschreibung 1 - details: Auf dieser Seite finden Sie eine Anleitung, wie Sie unser Projekt nutzen können - - title: Erklärung 1 - details: Lorem ipsum blablabla - - title: Beschreibung 2 - details: Lorem ipsum blablabla ---- - diff --git a/docs/packages/en/developerSection/index.md b/docs/packages/en/developerSection/index.md deleted file mode 100644 index 10f9f73..0000000 --- a/docs/packages/en/developerSection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Docs" - text: "Official Schulbuchaktion Documentation" - -features: - - title: Explanation 1 - details: On this page the viewer gets a description on how to work with our projekt - - title: Explanation 2 - details: Add documentation here - - title: Explanation 3 - details: Add documentation here ---- - diff --git a/docs/packages/en/index.md b/docs/packages/en/index.md deleted file mode 100644 index 3ef9c79..0000000 --- a/docs/packages/en/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Docs" - text: "Official Schulbuchaktion Documentation" - -features: - - title: Get to know the project - details: This site helps both users and developers better understand our project "Schulbuchaktion" - - title: From a user's point of view - details: The page "For Users" is designed to explain users how to use our project for their purposes - - title: From a developer's point of view - details: The page "For Developers" is dedicated to all developers who want to work with our product ---- - diff --git a/docs/packages/en/userSection/index.md b/docs/packages/en/userSection/index.md deleted file mode 100644 index c740acc..0000000 --- a/docs/packages/en/userSection/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -# https://vitepress.dev/reference/default-theme-home-page -layout: home - -hero: - name: "Schulbuchaktion Docs" - text: "Official Schulbuchaktion Documentation" - -features: - - title: Description 1 - details: On this page there is a manual on how to use our project - - title: Explanation 1 - details: Lorem ipsum blablabla - - title: Description 2 - details: Lorem ipsum blablabla ---- - From be1700abb9080243e00004c5ac977eefec3029fb Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Thu, 14 Mar 2024 22:57:24 +0100 Subject: [PATCH 09/14] feat: add htl logo svg --- docs/assets/htl-logo.svg | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/assets/htl-logo.svg diff --git a/docs/assets/htl-logo.svg b/docs/assets/htl-logo.svg new file mode 100644 index 0000000..43b0270 --- /dev/null +++ b/docs/assets/htl-logo.svg @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + From d30178e363613330f75f8822f80be8874536fdc4 Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Thu, 14 Mar 2024 22:57:32 +0100 Subject: [PATCH 10/14] feat: update package.json --- docs/package.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/package.json b/docs/package.json index 8aa09b6..7feb482 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,15 +1,16 @@ { "name": "docs", "version": "1.0.0", - "description": "", + "description": "Schulbuchaktion Docs", + "type": "module", "scripts": { "docs:dev": "vitepress dev", "docs:build": "vitepress build", "docs:preview": "vitepress preview" }, "keywords": [], - "author": "", - "license": "ISC", + "author": "Nixx Labs", + "license": "MIT", "devDependencies": { "vitepress": "1.0.0-rc.45" } From a1b9b683047c96bd4c8d98f3ae2f84105c8b8afd Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Fri, 15 Mar 2024 19:23:01 +0100 Subject: [PATCH 11/14] feat: add translations --- docs/.vitepress/config.ts | 37 +++---------- docs/.vitepress/de.ts | 110 ++++++++++++++++++++++++++++++++++++++ docs/.vitepress/en.ts | 80 +++++++++++++++++++++++++++ docs/.vitepress/shared.ts | 33 ++++++++++++ docs/developers/setup.md | 0 5 files changed, 230 insertions(+), 30 deletions(-) create mode 100644 docs/.vitepress/de.ts create mode 100644 docs/.vitepress/en.ts create mode 100644 docs/.vitepress/shared.ts create mode 100644 docs/developers/setup.md diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index af75699..b36db4f 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,35 +1,12 @@ import {defineConfig} from "vitepress" +import {shared} from "./shared" +import {en} from "./en" +import {de} from "./de" export default defineConfig({ - title: "Schulbuchaktion", - description: "Official Schulbuchaktion Documentation", - themeConfig: { - nav: [ - {text: "Home", link: "/"}, - {text: "Users", link: "userSection/"}, - {text: "Developers", link: "developerSection/"}, - ], - logo: {src: "/assets/htl-logo.svg"}, - socialLinks: [ - {icon: "github", link: "https://github.com/Dino-Kupinic/Schulbuchaktion.git"}, - ], - search: { - provider: "local", - }, - footer: { - message: "Released under the MIT License.", - copyright: "Copyright © 2024-present Nixx Labs", - }, - }, + ...shared, locales: { - root: { - label: "English", - lang: "en", - }, - de: { - label: "Deutsch", - lang: "de", - link: "/de/", - }, + root: {label: "English", ...en}, + de: {label: "Deutsch", ...de}, }, -}) +}) \ No newline at end of file diff --git a/docs/.vitepress/de.ts b/docs/.vitepress/de.ts new file mode 100644 index 0000000..6db14a8 --- /dev/null +++ b/docs/.vitepress/de.ts @@ -0,0 +1,110 @@ +import {DefaultTheme, defineConfig} from "vitepress" +import {FooterTranslations} from "vitepress/types/local-search" + +export const de = defineConfig({ + lang: "de-DE", + description: "Offizielle Schulbuchaktion Dokumentation", + themeConfig: { + nav: nav(), + sidebar: { + "/de/users/": { + base: "/de/users/", + items: sidebarUsers(), + }, + "/de/developers/": { + base: "/de/developers/", + items: sidebarDevelopers(), + }, + }, + footer: { + message: "Veröffentlicht unter der MIT Lizenz.", + copyright: "Copyright © 2024-jetzt Nixx Labs", + }, + docFooter: { + prev: "Vorheriges", + next: "Nächstes", + }, + }, +}) + +function nav(): DefaultTheme.NavItem[] { + return [ + { + text: "Home", + link: "/de/", + }, + { + text: "Leitfaden", + link: "/de/guide", + }, + { + text: "Nutzer", + link: "/de/users/getting-started", + }, + { + text: "Entwickler", + link: "/de/developers/setup", + }, + ] +} + +function sidebarUsers(): DefaultTheme.SidebarItem[] { + return [ + { + text: "Einführung", + collapsed: false, + items: [ + {text: "Erste Schritte", link: "getting-started"}, + {text: "Authentifizierung", link: "auth"}, + {text: "Hilfe", link: "help"}, + ], + }, + { + text: "Anpassung", + collapsed: false, + items: [ + { + text: "Die Farben ändern", + link: "theme-colors", + }, + { + text: "Zwischen Hell und Dunkel wechseln", + link: "light-dark-mode", + }, + { + text: "Sprache", + link: "language-settings", + }, + ], + }, + ] +} + +function sidebarDevelopers(): DefaultTheme.SidebarItem[] { + return [] +} + +export const search: DefaultTheme.LocalSearchOptions["locales"] = { + de: { + translations: { + button: { + buttonText: "Suchen", + buttonAriaLabel: "Suchen", + }, + modal: { + displayDetails: "Details anzeigen", + resetButtonTitle: "Zurücksetzen", + backButtonTitle: "Zurück", + noResultsText: "Keine Resultate", + footer: { + selectText: "Auswählen", + navigateText: "Navigieren", + navigateUpKeyAriaLabel: "Nach oben", + navigateDownKeyAriaLabel: "Nach unten", + closeText: "Schließen", + closeKeyAriaLabel: "Schließen", + }, + }, + }, + }, +} \ No newline at end of file diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts new file mode 100644 index 0000000..c6a4ebf --- /dev/null +++ b/docs/.vitepress/en.ts @@ -0,0 +1,80 @@ +import {DefaultTheme, defineConfig} from "vitepress" + +export const en = defineConfig({ + lang: "en-US", + description: "Official Schulbuchaktion Documentation", + themeConfig: { + nav: nav(), + sidebar: { + "/users/": { + base: "/users/", + items: sidebarUsers(), + }, + "/developers/": { + base: "/developers/", + items: sidebarDevelopers(), + }, + }, + footer: { + message: "Released under the MIT License.", + copyright: "Copyright © 2024-present Nixx Labs", + }, + }, +}) + +function nav(): DefaultTheme.NavItem[] { + return [ + { + text: "Home", + link: "/", + }, + { + text: "Guide", + link: "/guide", + }, + { + text: "Users", + link: "/users/getting-started", + }, + { + text: "Developers", + link: "/developers/setup", + }, + ] +} + +function sidebarUsers(): DefaultTheme.SidebarItem[] { + return [ + { + text: "Introduction", + collapsed: false, + items: [ + {text: "Getting Started", link: "getting-started"}, + {text: "Authentication", link: "auth"}, + {text: "Getting help", link: "help"}, + ], + }, + { + text: "Customization", + collapsed: false, + items: [ + { + text: "Changing the theme colors", + link: "theme-colors", + }, + { + text: "Altering between light and dark mode", + link: "light-dark-mode", + }, + { + text: "Language", + link: "language-settings", + }, + ], + }, + ] +} + +function sidebarDevelopers(): DefaultTheme.SidebarItem[] { + return [] +} \ No newline at end of file diff --git a/docs/.vitepress/shared.ts b/docs/.vitepress/shared.ts new file mode 100644 index 0000000..1e4c18b --- /dev/null +++ b/docs/.vitepress/shared.ts @@ -0,0 +1,33 @@ +import {defineConfig} from "vitepress" +import {search as deSearch} from "./de" + +export const shared = defineConfig({ + title: "Schulbuchaktion", + sitemap: { + hostname: "https://schulbuchaktion-docs.vercel.app", + }, + head: [ + ["meta", {property: "og:type", content: "website"}], + ["meta", {property: "og:locale", content: "en"}], + ["meta", {property: "og:title", content: "Schulbuchaktion | Official Schulbuchaktion Documentation"}], + ["meta", {property: "og:site_name", content: "Schulbuchaktion"}], + ["meta", {property: "og:url", content: "https://schulbuchaktion-docs.vercel.app/"}], + ], + themeConfig: { + logo: { + src: "/assets/htl-logo.svg", + }, + socialLinks: [ + { + icon: "github", + link: "https://github.com/Dino-Kupinic/Schulbuchaktion.git", + }, + ], + search: { + provider: "local", + options: { + locales: {...deSearch}, + }, + }, + }, +}) \ No newline at end of file diff --git a/docs/developers/setup.md b/docs/developers/setup.md new file mode 100644 index 0000000..e69de29 From d616995098cee9b58f2208f10ac09821637f6f4e Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Fri, 15 Mar 2024 19:53:35 +0100 Subject: [PATCH 12/14] feat: setup basic docs structure --- .gitignore | 1 + docs/.vitepress/de.ts | 4 -- docs/.vitepress/en.ts | 4 -- .../developers/setup.md} | 0 docs/de/index.md | 72 +++++++++++++++++++ docs/de/users/auth.md | 0 docs/de/users/getting-started.md | 7 ++ docs/de/users/help.md | 0 docs/de/users/language-settings.md | 0 docs/de/users/light-dark-mode.md | 0 docs/de/users/theme-colors.md | 0 docs/index.md | 1 - docs/users/auth.md | 0 docs/users/getting-started.md | 7 ++ docs/users/help.md | 0 docs/users/language-settings.md | 0 docs/users/light-dark-mode.md | 0 docs/users/theme-colors.md | 0 18 files changed, 87 insertions(+), 9 deletions(-) rename docs/{getting-started => de/developers/setup.md} (100%) create mode 100644 docs/de/index.md create mode 100644 docs/de/users/auth.md create mode 100644 docs/de/users/getting-started.md create mode 100644 docs/de/users/help.md create mode 100644 docs/de/users/language-settings.md create mode 100644 docs/de/users/light-dark-mode.md create mode 100644 docs/de/users/theme-colors.md create mode 100644 docs/users/auth.md create mode 100644 docs/users/getting-started.md create mode 100644 docs/users/help.md create mode 100644 docs/users/language-settings.md create mode 100644 docs/users/light-dark-mode.md create mode 100644 docs/users/theme-colors.md diff --git a/.gitignore b/.gitignore index 8fbf6de..c51851c 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ backend/.env frontend/.env /docs/.vitepress/cache/ /docs/.vitepress/dist/ +/docs/node_modules diff --git a/docs/.vitepress/de.ts b/docs/.vitepress/de.ts index 6db14a8..b655462 100644 --- a/docs/.vitepress/de.ts +++ b/docs/.vitepress/de.ts @@ -33,10 +33,6 @@ function nav(): DefaultTheme.NavItem[] { text: "Home", link: "/de/", }, - { - text: "Leitfaden", - link: "/de/guide", - }, { text: "Nutzer", link: "/de/users/getting-started", diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index c6a4ebf..899a657 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -28,10 +28,6 @@ function nav(): DefaultTheme.NavItem[] { text: "Home", link: "/", }, - { - text: "Guide", - link: "/guide", - }, { text: "Users", link: "/users/getting-started", diff --git a/docs/getting-started b/docs/de/developers/setup.md similarity index 100% rename from docs/getting-started rename to docs/de/developers/setup.md diff --git a/docs/de/index.md b/docs/de/index.md new file mode 100644 index 0000000..5141ade --- /dev/null +++ b/docs/de/index.md @@ -0,0 +1,72 @@ +--- +layout: home + +title: Schulbuchaktion +titleTemplate: Der einfachste Weg zur Verwaltung von Schulbüchern + +hero: + name: "Schulbuchaktion" + text: "Dokumentation" + tagline: 📚 Schulbücher einfach verwalten + actions: + - theme: brand + text: Schnellstart für Benutzer + link: /guide/getting-started + - theme: alt + text: Entwicklerreferenz + link: https://github.com/vuejs/vitepress + image: + src: ../assets/htl-logo.svg + alt: VitePress + +features: + - icon: 📑 + title: Bestellliste + details: Einfache Buchbestellung, effiziente Klassenverwaltung. + - icon: 👩‍👧‍👦 + title: Klassenverwaltung + details: Effiziente Schüler- und Klassenverwaltung. + - icon: 💵 + title: Budgetübersicht + details: Analyse des Budgets für fundierte Entscheidungen. + - icon: 💡 + title: Importieren + details: XLSX-Dateien mühelos importieren + - icon: 🎨 + title: Anpassbar + details: Personalisierte Farben, Designs und Spracheinstellungen. + - icon: 🔐 + title: Sicherheit + details: Datensicherheit durch robuste Maßnahmen. + - icon: 🚀 + title: Leistungsstark + details: Erleben Sie schnelle, reaktionsschnelle Leistung für nahtlose Operationen. +--- + + + diff --git a/docs/de/users/auth.md b/docs/de/users/auth.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/de/users/getting-started.md b/docs/de/users/getting-started.md new file mode 100644 index 0000000..cd032dc --- /dev/null +++ b/docs/de/users/getting-started.md @@ -0,0 +1,7 @@ +# Getting started + + \ No newline at end of file diff --git a/docs/de/users/help.md b/docs/de/users/help.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/de/users/language-settings.md b/docs/de/users/language-settings.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/de/users/light-dark-mode.md b/docs/de/users/light-dark-mode.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/de/users/theme-colors.md b/docs/de/users/theme-colors.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md index 71ea3f4..7bdf97b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -51,7 +51,6 @@ features: --vp-home-hero-image-background-image: linear-gradient(-45deg, #242a3b 50%, #428faf 50%); --vp-home-hero-image-filter: blur(44px); - } .dark { diff --git a/docs/users/auth.md b/docs/users/auth.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/users/getting-started.md b/docs/users/getting-started.md new file mode 100644 index 0000000..cd032dc --- /dev/null +++ b/docs/users/getting-started.md @@ -0,0 +1,7 @@ +# Getting started + + \ No newline at end of file diff --git a/docs/users/help.md b/docs/users/help.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/users/language-settings.md b/docs/users/language-settings.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/users/light-dark-mode.md b/docs/users/light-dark-mode.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/users/theme-colors.md b/docs/users/theme-colors.md new file mode 100644 index 0000000..e69de29 From d02dc5a27baf6990b4c6978f144d04d0fec4e3d7 Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Sat, 16 Mar 2024 15:40:45 +0100 Subject: [PATCH 13/14] fix: adjust hero section links --- docs/de/index.md | 4 ++-- docs/index.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/de/index.md b/docs/de/index.md index 5141ade..7a27cfc 100644 --- a/docs/de/index.md +++ b/docs/de/index.md @@ -11,10 +11,10 @@ hero: actions: - theme: brand text: Schnellstart für Benutzer - link: /guide/getting-started + link: /de/users/getting-started - theme: alt text: Entwicklerreferenz - link: https://github.com/vuejs/vitepress + link: /de/developers/setup image: src: ../assets/htl-logo.svg alt: VitePress diff --git a/docs/index.md b/docs/index.md index 7bdf97b..7a46e17 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,10 +11,10 @@ hero: actions: - theme: brand text: Quickstart for Users - link: /guide/getting-started + link: /users/getting-started - theme: alt text: Developer Reference - link: https://github.com/vuejs/vitepress + link: /developers/setup image: src: assets/htl-logo.svg alt: VitePress From 74f03865c648cb792ad4278d9ea46df6264b049c Mon Sep 17 00:00:00 2001 From: Dino-Kupinic Date: Mon, 18 Mar 2024 09:16:34 +0100 Subject: [PATCH 14/14] feat: add auth section --- docs/.vitepress/de.ts | 13 ++++++++++++- docs/.vitepress/en.ts | 13 ++++++++++++- docs/de/developers/ldap.md | 1 + docs/developers/ldap.md | 1 + 4 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 docs/de/developers/ldap.md create mode 100644 docs/developers/ldap.md diff --git a/docs/.vitepress/de.ts b/docs/.vitepress/de.ts index b655462..726b971 100644 --- a/docs/.vitepress/de.ts +++ b/docs/.vitepress/de.ts @@ -77,7 +77,18 @@ function sidebarUsers(): DefaultTheme.SidebarItem[] { } function sidebarDevelopers(): DefaultTheme.SidebarItem[] { - return [] + return [ + { + text: "Authentifizierung", + collapsed: false, + items: [ + { + text: "LDAP", + link: "ldap", + }, + ], + }, + ] } export const search: DefaultTheme.LocalSearchOptions["locales"] = { diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index 899a657..f02ed4d 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -72,5 +72,16 @@ function sidebarUsers(): DefaultTheme.SidebarItem[] { } function sidebarDevelopers(): DefaultTheme.SidebarItem[] { - return [] + return [ + { + text: "Authentication", + collapsed: false, + items: [ + { + text: "LDAP", + link: "ldap", + }, + ], + }, + ] } \ No newline at end of file diff --git a/docs/de/developers/ldap.md b/docs/de/developers/ldap.md new file mode 100644 index 0000000..da654da --- /dev/null +++ b/docs/de/developers/ldap.md @@ -0,0 +1 @@ +# LDAP \ No newline at end of file diff --git a/docs/developers/ldap.md b/docs/developers/ldap.md new file mode 100644 index 0000000..da654da --- /dev/null +++ b/docs/developers/ldap.md @@ -0,0 +1 @@ +# LDAP \ No newline at end of file