Skip to content
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ go.work
node_modules/
docs/.vitepress/cache/*
docs/.vitepress/dist/*
.vitepress/
.vitepress/cache
.vitepress/dist
.cache
/**/.DS_Store
config/generator/target
71 changes: 71 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import { withMermaid } from "vitepress-plugin-mermaid";
import { fileURLToPath, URL } from 'node:url'

// https://vitepress.dev/reference/site-config
export default withMermaid({
title: "AnyApplication controller",
description: "AnyApplication Controller for Decentralized Control Plane",
base: "/",
head: [['link', { rel: 'icon', href: 'https://github.com/HIRO-MicroDataCenters-BV/anyapplication-controller/refs/heads/main/docs/assets/dcp-log.png' }]],
vite: {
resolve: {
alias: [
{
find: /^.*\/VPFooter\.vue$/,
replacement: fileURLToPath(
new URL('./theme/components/VPFooter.vue', import.meta.url)
)
},
]
}
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Concepts', link: '/concepts' },
{ text: 'Usage', link: '/usage' },
],

editLink: {
pattern: 'https://github.com/HIRO-MicroDataCenters-BV/anyapplication-controller/blob/main/docs/:path',
text: 'Edit this page on GitHub'
},

logo: {
src: 'https://github.com/HIRO-MicroDataCenters-BV/anyapplication-controller/refs/heads/main/docs/assets/dcp-log.png',
width: 24,
height: 24
},

search: {
provider: 'local'
},

sidebar: [
{
items: [
{ text: 'Quick Start', link: '/usage/installation' },
{ text: 'Architecture', link: '/architecture' },
{ text: 'API Reference', link: '/api-reference/anyapplication' },
]
},
{
text: 'Developer Guide',
collapsed: false,
items: [
{ text: 'Local Dev Setup', link: '/development/setup' },
]
}
],

footer: {
message: 'Released under the Apache License 2.0.',
copyright: 'Copyright © 2025-present HIRO-MicroDataCenters BV'
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/HIRO-MicroDataCenters-BV/anyapplication-controller' }
],
}
})
68 changes: 68 additions & 0 deletions docs/.vitepress/theme/components/VPFooter.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@

<!--
Copied and adapted from: https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/components/VPFooter.vue
-->

<script setup lang="ts">

import { useData } from '../composables/data'
const { theme, frontmatter } = useData()

import { useSidebar } from 'vitepress/theme';
const { hasSidebar } = useSidebar()

// import {withBase} from "vitepress";
</script>

<template>
<footer v-if="theme.footer && frontmatter.footer !== false" class="VPFooter" :class="{ 'has-sidebar': hasSidebar }">
<div class="container">
<p v-if="theme.footer.message" class="message" v-html="theme.footer.message"></p>
<p v-if="theme.footer.copyright" class="copyright" v-html="theme.footer.copyright"></p>
</div>
</footer>
</template>

<style scoped>
.VPFooter {
position: relative;
z-index: var(--vp-z-index-footer);
border-top: 1px solid var(--vp-c-gutter);
padding: 32px 24px;
background-color: var(--vp-c-bg);
}

.VPFooter.has-sidebar {
display: none;
}

.VPFooter :deep(a) {
text-decoration-line: underline;
text-underline-offset: 2px;
transition: color 0.25s;
}

.VPFooter :deep(a:hover) {
color: var(--vp-c-text-1);
}

@media (min-width: 768px) {
.VPFooter {
padding: 32px;
}
}

.container {
margin: 0 auto;
max-width: var(--vp-layout-max-width);
text-align: center;
}

.message,
.copyright {
line-height: 24px;
font-size: 14px;
font-weight: 500;
color: var(--vp-c-text-2);
}
</style>
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/composables/data.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { useData as useData$ } from 'vitepress'
import type { DefaultTheme } from 'vitepress/theme'

export const useData: typeof useData$<DefaultTheme.Config> = useData$
37 changes: 37 additions & 0 deletions docs/.vitepress/theme/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#3456fe 30%,
#41d1ff
);
--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#3474fe 50%,
#47caff 50%
);
--vp-home-hero-image-filter: blur(44px);
}

@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(56px);
}
}

@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(68px);
}
}

.VPHero .VPImage {
filter: drop-shadow(-2px 4px 6px rgba(0, 0, 0, 0.2));
padding: 18px;
}

/* used in reference/default-theme-search */
img[src='/search.png'] {
width: 100%;
aspect-ratio: 1 / 1;
}
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import DefaultTheme from 'vitepress/theme'
import './custom.css'

export default DefaultTheme
Binary file added docs/assets/dcp-log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Empty file added docs/development/index.md
Empty file.
Empty file added docs/development/setup.md
Empty file.
Empty file added docs/index.md
Empty file.
Empty file added docs/usage/index.md
Empty file.
Empty file added docs/usage/installation.md
Empty file.
Loading