Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/docs init structure and landingpage #323

Merged
merged 8 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
dist
node_modules
1 change: 1 addition & 0 deletions docs/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"@muenchen/prettier-codeformat"
61 changes: 47 additions & 14 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -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" },
],
},
simonhir marked this conversation as resolved.
Show resolved Hide resolved
],
sidebar: [
{ text: "Overview", link: "/overview" },
{ text: "API-Gateway", link: "/gateway" },
{
text: "Integrations",
link: "/integrations",
items: [{ text: "S3", link: "/integrations/s3" }],
devtobi marked this conversation as resolved.
Show resolved Hide resolved
},
{
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>`,
simonhir marked this conversation as resolved.
Show resolved Hide resolved
},
},
});

export default withMermaid(vitepressConfig);
export default withMermaid(vitepressConfig);
46 changes: 46 additions & 0 deletions docs/.vitepress/theme/LhmThemeExtension.vue
Original file line number Diff line number Diff line change
@@ -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"
>
simonhir marked this conversation as resolved.
Show resolved Hide resolved
<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>
10 changes: 10 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import DefaultTheme from "vitepress/theme";

import LhmThemeExtension from "./LhmThemeExtension.vue";

import "./style.css";

export default {
...DefaultTheme,
Layout: LhmThemeExtension,
};
Binary file added docs/.vitepress/theme/logo-lhm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/.vitepress/theme/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
:root {
--muc-logo-filter: invert(0);
}

footer.VPFooter {
display: block !important;
z-index: 100 !important;
}
1 change: 1 addition & 0 deletions docs/dev/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Development
1 change: 1 addition & 0 deletions docs/dev/stack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Development Stack
1 change: 1 addition & 0 deletions docs/dev/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Tools
1 change: 1 addition & 0 deletions docs/gateway.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# API-Gateway
36 changes: 22 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

1 change: 1 addition & 0 deletions docs/integrations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Integrations
1 change: 1 addition & 0 deletions docs/integrations/s3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# S3-Integration
1 change: 1 addition & 0 deletions docs/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Overview
Loading
Loading