Skip to content

Commit aae45ea

Browse files
Beginning of the union (docs - releases) (#32)
1 parent 0120c4c commit aae45ea

38 files changed

+1000
-148
lines changed

docs/.vitepress/config.mts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
// If the subfolder is e.g. 'docs/dist', the env var BASE_DIR should be set to '/docs/dist/'.
88
//////////////////////////////////////////////////////////////////////////
99

10-
import { defineConfig, withBase } from 'vitepress'
10+
import { defineConfig } from 'vitepress'
11+
import tabsPlugin from '@red-asuka/vitepress-plugin-tabs'
1112
import { head, navbar_EN, navbar_DE, sidebar_EN, sidebar_DE } from './configs'
1213
import path from 'path'
1314
import fs from 'fs'
@@ -20,6 +21,11 @@ export default defineConfig({
2021
titleTemplate: ":title · Hyperion documentation",
2122
description: "Hyperion Ambient Light documentation",
2223
lastUpdated: true,
24+
markdown: {
25+
config: (md) => {
26+
tabsPlugin(md)
27+
},
28+
},
2329
themeConfig: {
2430
siteTitle: '',
2531
externalLinkIcon: true,

docs/.vitepress/configs/navbar/de.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const navbar_DE: any = [
66
text: 'Anleitungen',
77
items: [
88
{ text: 'Einführung', link: '/de/user/Introduction.md' },
9-
{ text: 'Erste Schritte', link: '/de/user/GettingStarted.md' },
9+
{ text: 'Erste Schritte', link: '/de/user/gettingstarted/Overview.md' },
1010
{ text: 'Konfigurieren', link: '/de/user/Configuration.md' },
1111
{ text: 'LED Hardware', link: '/de/user/leddevices/Overview.md' },
1212
{ text: 'HyperBian', link: '/de/user/HyperBian.md' }

docs/.vitepress/configs/navbar/en.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const navbar_EN: any = [
66
text: 'General',
77
items: [
88
{ text: 'Introduction', link: '/user/Introduction.md' },
9-
{ text: 'Getting Started', link: '/user/GettingStarted.md' },
9+
{ text: 'Getting Started', link: '/user/gettingstarted/Overview.md' },
1010
{ text: 'Configuration', link: '/user/Configuration.md' },
1111
{ text: 'LED Hardware', link: '/user/leddevices/Overview.md' },
1212
{ text: 'HyperBian', link: '/user/HyperBian.md' }

docs/.vitepress/configs/sidebar/de.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,20 @@ export const sidebar_DE: any = {
44
text: 'Allgemein',
55
items: [
66
{ text: 'Einführung', link: '/de/user/Introduction.md' },
7-
{ text: 'Erste Schritte', link: '/de/user/GettingStarted.md' },
7+
{
8+
text: 'Erste Schritte',
9+
items: [
10+
{ text: 'Übersicht', link: '/de/user/gettingstarted/Overview.md' },
11+
{ text: 'Installieren',
12+
collapsed: true,
13+
items: [
14+
{ text: 'Linux', link: '/de/user/gettingstarted/Linux.md' },
15+
{ text: 'Windows', link: '/de/user/gettingstarted/Windows.md' },
16+
{ text: 'macOS', link: '/de/user/gettingstarted/macOS.md' }
17+
]
18+
}
19+
]
20+
},
821
{ text: 'Konfigurieren', link: '/de/user/Configuration.md' },
922
{
1023
text: 'LED Hardware',

docs/.vitepress/configs/sidebar/en.ts

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,20 @@ export const sidebar_EN: any = {
44
text: 'General',
55
items: [
66
{ text: 'Introduction', link: '/user/Introduction.md' },
7-
{ text: 'Getting Started', link: '/user/GettingStarted.md' },
7+
{
8+
text: 'Getting Started',
9+
items: [
10+
{ text: 'Overview', link: '/user/gettingstarted/Overview.md' },
11+
{ text: 'Installation',
12+
collapsed: true,
13+
items: [
14+
{ text: 'Linux', link: '/user/gettingstarted/Linux.md' },
15+
{ text: 'Windows', link: '/user/gettingstarted/Windows.md' },
16+
{ text: 'macOS', link: '/user/gettingstarted/macOS.md' }
17+
]
18+
}
19+
]
20+
},
821
{ text: 'Configuration', link: '/user/Configuration.md' },
922
{
1023
text: 'LED Hardware',

docs/.vitepress/theme/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
import DefaultTheme from 'vitepress/theme'
22
import { h } from 'vue'
3+
import { Tab, Tabs } from 'vue3-tabs-component'
34
import ExtendedLayout from './components/ExtendedLayout.vue'
45
import ImageWrap from './components/ImageWrap.vue'
56
import Contributors from './components/Contributors.vue'
67
import FloatingVue from 'floating-vue'
78

89
import 'floating-vue/dist/style.css'
10+
import '@red-asuka/vitepress-plugin-tabs/dist/style.css'
911
import './styles/index.css'
1012

1113
export default {
@@ -14,6 +16,8 @@ export default {
1416
return h(ExtendedLayout)
1517
},
1618
enhanceApp({ app }) {
19+
app.component('Tab', Tab)
20+
app.component('Tabs', Tabs)
1721
app.component('ImageWrap', ImageWrap)
1822
app.component('Contributors', Contributors)
1923
app.use(FloatingVue)

docs/de/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ hero:
1616
actions:
1717
- theme: brand
1818
text: 🚀 Los geht's
19-
link: /de/user/GettingStarted.md
19+
link: /de/user/gettingstarted/Overview.md
2020
- theme: alt
2121
text: Was ist Hyperion?
2222
link: /de/user/Introduction.md

docs/de/user/GettingStarted.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,6 @@ Ersetze ${USER} durch den Benutzernamen, wenn der Benutzer zuvor mit der Option
129129
systemctl status hyperion@${USER}
130130
```
131131

132-
133-
134-
135132
<style>
136133
.vp-doc table {
137134
display: table;

0 commit comments

Comments
 (0)