Feat/docs init structure and landingpage (#323)

* ✨ docs add prettier

* ✨ docs add favicon

* ✨ docs add edit link

* ✨ docs init content structure

* ✨ docs lhm theme

* ✨ docs display footer on docs pages

* ✨ docs add footer

docs/.prettierignore

@@ -0,0 +1,2 @@
+dist
+node_modules

docs/.prettierrc

@@ -0,0 +1 @@
+"@muenchen/prettier-codeformat"

docs/.vitepress/config.mts

@@ -1,32 +1,65 @@
 import { defineConfig } from "vitepress";
-import { withMermaid } from "vitepress-plugin-mermaid";
+import { withMermaid } from "vitepress-plugin-mermaid"; // https://vitepress.dev/reference/site-config
 
 // https://vitepress.dev/reference/site-config
 const vitepressConfig = defineConfig({
-  title: "Refarch Vitepress init",
+  title: "RefArch",
   description: "Documentation for the RefArch",
+  head: [
+    [
+      "link",
+      {
+        rel: "icon",
+        href: `https://assets.muenchen.de/logos/lhm/icon-lhm-muenchen-32.png`,
+      },
+    ],
+  ],
+  lastUpdated: true,
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: "Home", link: "/" },
+      {
+        text: "Docs",
+        items: [
+          { text: "Overview", link: "/overview" },
+          { text: "API-Gateway", link: "/gateway" },
+          { text: "Integrations", link: "/integrations" },
+          { text: "Development", link: "/dev" },
+        ],
+      },
     ],
     sidebar: [
+      { text: "Overview", link: "/overview" },
+      { text: "API-Gateway", link: "/gateway" },
+      {
+        text: "Integrations",
+        link: "/integrations",
+        items: [{ text: "S3", link: "/integrations/s3" }],
+      },
       {
-        text: 'Examples',
+        text: "Development",
+        link: "/dev",
         items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
-        ]
-      }
+          { text: "Tools", link: "/dev/tools" },
+          { text: "Stack", link: "/dev/stack" },
+        ],
+      },
     ],
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+      { icon: "github", link: "https://github.com/it-at-m/refarch" },
     ],
+    editLink: {
+      pattern: "https://github.com/it-at-m/refarch/blob/main/docs/:path",
+      text: "View this page on GitHub",
+    },
     search: {
-      provider: 'local'
-    }
-  }
+      provider: "local",
+    },
+    footer: {
+      message: `<a href="https://opensource.muenchen.de/impress.html">Impress and Contact</a>`,
+    },
+  },
 });
 
-export default withMermaid(vitepressConfig);
+export default withMermaid(vitepressConfig);

docs/.vitepress/theme/LhmThemeExtension.vue

@@ -0,0 +1,46 @@
+<script setup>
+import DefaultTheme from "vitepress/theme";
+
+import lhmLogo from "./logo-lhm.png";
+
+const { Layout } = DefaultTheme;
+</script>
+<template>
+  <Layout>
+    <template #nav-bar-content-after>
+      <div class="logo">
+        <a
+          href="https://www.muenchen.de/"
+          target="_blank"
+        >
+          <img
+            :src="lhmLogo"
+            alt="Logo Landeshauptstadt München"
+          />
+        </a>
+      </div>
+    </template>
+  </Layout>
+</template>
+
+<style scoped>
+.logo {
+  display: flex;
+  align-items: center;
+}
+@media (min-width: 768px) {
+  .extra + .logo:before {
+    margin-right: 16px;
+    margin-left: 16px;
+    width: 1px;
+    height: 24px;
+    background-color: var(--vp-c-divider);
+    content: "";
+  }
+}
+
+.logo img {
+  filter: var(--muc-logo-filter);
+  height: 28px;
+}
+</style>

docs/.vitepress/theme/index.ts

@@ -0,0 +1,10 @@
+import DefaultTheme from "vitepress/theme";
+
+import LhmThemeExtension from "./LhmThemeExtension.vue";
+
+import "./style.css";
+
+export default {
+  ...DefaultTheme,
+  Layout: LhmThemeExtension,
+};

docs/.vitepress/theme/style.css

@@ -0,0 +1,8 @@
+:root {
+    --muc-logo-filter: invert(0);
+}
+
+footer.VPFooter {
+    display: block !important;
+    z-index: 100 !important;
+}

docs/dev/index.md

@@ -0,0 +1 @@
+# Development

docs/dev/stack.md

@@ -0,0 +1 @@
+# Development Stack

docs/dev/tools.md

@@ -0,0 +1 @@
+# Tools

docs/gateway.md

@@ -0,0 +1 @@
+# API-Gateway

docs/index.md

@@ -3,23 +3,31 @@
 layout: home
 
 hero:
-  name: "Refarch Vitepress init"
-  text: "Documentation for the RefArch"
-  tagline: My great project tagline
+  name: "RefArch"
+  text: "Documentation for the reference architecture of it@M"
+  tagline: "Standardized way for developing web applications"
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: Overview
+      link: /overview
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: Templates
+      link: https://refarch-templates.oss.muenchen.de
+    - theme: alt
+      text: API-Gateway
+      link: /gateway
+    - theme: alt
+      text: Integrations
+      link: /integrations
 
 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
+  - icon: 🕒
+    title: Time Savings
+    details: Focus on building features instead of reinventing the wheel.
+  - icon: 💎
+    title: High Quality
+    details: Leverage well-tested and reliable components that enhance your project’s stability.
+  - icon: 🔌
+    title: Easy Integration
+    details: Our components are designed for effortless integration, ensuring a smooth workflow.
 ---
-

docs/integrations/index.md

@@ -0,0 +1 @@
+# Integrations

docs/integrations/s3.md

@@ -0,0 +1 @@
+# S3-Integration

docs/overview.md

@@ -0,0 +1 @@
+# Overview