Skip to content

Commit 45d418f

Browse files
Paulchen-PantherPaulchen-Panther
authored
Update/Correct Contributors Avatars; Add Sponsor Link (#28)
Co-authored-by @lordgrey
1 parent 534fd3e commit 45d418f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+541
-2743
lines changed

‎.vscode/tasks.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88
"type": "shell",
99
"command": "npm",
1010
"args": ["run", "docs:dev"],
11-
"detail": "vuepress dev content"
11+
"detail": "vitepress dev content"
1212
},
1313
{
1414
"label": "build",
1515
"type": "shell",
1616
"command": "npm",
1717
"args": ["run", "docs:build"],
18-
"detail": "vuepress build content"
18+
"detail": "vitepress build content"
1919
}
2020

2121
]

‎docs/.vitepress/config.mts‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
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 } from 'vitepress'
10+
import { defineConfig, withBase } from 'vitepress'
1111
import { head, navbar_EN, navbar_DE, sidebar_EN, sidebar_DE } from './configs'
12+
import path from 'path'
13+
import fs from 'fs'
1214

1315
export default defineConfig({
1416
head: head,
@@ -20,12 +22,23 @@ export default defineConfig({
2022
lastUpdated: true,
2123
themeConfig: {
2224
siteTitle: '',
25+
externalLinkIcon: true,
2326
// @ts-expect-error
2427
notFoundLight: '/notFound.png',
2528
notFoundDark: '/notFoundDark.png',
2629
socialLinks: [
27-
{ icon: 'github', link: 'https://github.com/hyperion-project/hyperion.ng' },
28-
{ icon: 'discord', link: 'https://discord.com/invite/XtVTb3HEKS' }
30+
{
31+
icon: { svg: fs.readFileSync(path.resolve(__dirname, '../public/icons/svg/github.svg'), 'utf8')},
32+
link: 'https://github.com/hyperion-project'
33+
},
34+
{
35+
icon: { svg: fs.readFileSync(path.resolve(__dirname, '../public/icons/svg/discord.svg'), 'utf8')},
36+
link: 'https://discord.com/invite/XtVTb3HEKS'
37+
},
38+
{
39+
icon: { svg: fs.readFileSync(path.resolve(__dirname, '../public/icons/svg/support.svg'), 'utf8')},
40+
link: 'https://www.paypal.me/HyperionAmbi'
41+
}
2942
],
3043
logo: {
3144
light: '/logo.png',
@@ -162,5 +175,14 @@ export default defineConfig({
162175
}
163176
}
164177
},
165-
}
178+
},
179+
transformPageData(pageData) {
180+
if (pageData.frontmatter.layout === "home" && Object.keys(pageData.frontmatter.features)?.length) {
181+
pageData.frontmatter.features[0].icon = fs.readFileSync(path.resolve(__dirname, '../public/icons/svg/effects.svg'), 'utf8')
182+
pageData.frontmatter.features[1].icon = fs.readFileSync(path.resolve(__dirname, '../public/icons/svg/json.svg'), 'utf8')
183+
pageData.frontmatter.features[2].icon = fs.readFileSync(path.resolve(__dirname, '../public/icons/svg/forum.svg'), 'utf8')
184+
pageData.frontmatter.features[3].icon = fs.readFileSync(path.resolve(__dirname, '../public/icons/svg/github.svg'), 'utf8')
185+
}
186+
}
166187
})
188+

‎docs/.vitepress/configs/head.ts‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,44 +6,44 @@ export const head: HeadConfig[] = [
66
['meta', {'http-equiv': 'pragma', content: 'no-cache'}],
77
['meta', {'http-equiv': 'expires', content: '0'}],
88

9-
['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: BASE_DIR + 'icons/favicon-16x16.png' }],
10-
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: BASE_DIR + 'icons/favicon-32x32.png' }],
11-
['link', { rel: 'icon', type: 'image/png', sizes: '96x96', href: BASE_DIR + 'icons/favicon-96x96.png' }],
12-
['link', { rel: 'icon', type: 'image/png', sizes: '128x128', href: BASE_DIR + 'icons/favicon-128x128.png' }],
13-
['link', { rel: 'icon', type: 'image/ico', href: BASE_DIR + 'icons/favicon.ico' }],
9+
['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: BASE_DIR + 'icons/head/favicon-16x16.png' }],
10+
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: BASE_DIR + 'icons/head/favicon-32x32.png' }],
11+
['link', { rel: 'icon', type: 'image/png', sizes: '96x96', href: BASE_DIR + 'icons/head/favicon-96x96.png' }],
12+
['link', { rel: 'icon', type: 'image/png', sizes: '128x128', href: BASE_DIR + 'icons/head/favicon-128x128.png' }],
13+
['link', { rel: 'icon', type: 'image/ico', href: BASE_DIR + 'icons/head/favicon.ico' }],
1414

1515
// iPhone XR
16-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 414px) and (device-height: 896px) and (-webkit-device-pixel-ratio: 2)", href: BASE_DIR + "icons/apple-launch-828x1792.png" }],
16+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 414px) and (device-height: 896px) and (-webkit-device-pixel-ratio: 2)', href: BASE_DIR + 'icons/head/apple-launch-828x1792.png' }],
1717
// iPhone X, XS
18-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 375px) and (device-height: 812px) and (-webkit-device-pixel-ratio: 3)", href: BASE_DIR + "icons/apple-launch-1125x2436.png" }],
18+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 375px) and (device-height: 812px) and (-webkit-device-pixel-ratio: 3)', href: BASE_DIR + 'icons/head/apple-launch-1125x2436.png' }],
1919
// iPhone XS Max
20-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 414px) and (device-height: 896px) and (-webkit-device-pixel-ratio: 3)", href: BASE_DIR + "icons/apple-launch-1242x2688.png" }],
20+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 414px) and (device-height: 896px) and (-webkit-device-pixel-ratio: 3)', href: BASE_DIR + 'icons/head/apple-launch-1242x2688.png' }],
2121
// iPhone 8, 7, 6s, 6
22-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 375px) and (device-height: 667px) and (-webkit-device-pixel-ratio: 2)", href: BASE_DIR + "icons/apple-launch-750x1334.png" }],
22+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 375px) and (device-height: 667px) and (-webkit-device-pixel-ratio: 2)', href: BASE_DIR + 'icons/head/apple-launch-750x1334.png' }],
2323
// iPhone 8 Plus, 7 Plus, 6s Plus, 6 Plus
24-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 414px) and (device-height: 736px) and (-webkit-device-pixel-ratio: 3)", href: BASE_DIR + "icons/apple-launch-1242x2208.png" }],
24+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 414px) and (device-height: 736px) and (-webkit-device-pixel-ratio: 3)', href: BASE_DIR + 'icons/head/apple-launch-1242x2208.png' }],
2525
// iPhone 5
26-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 320px) and (device-height: 568px) and (-webkit-device-pixel-ratio: 2)", href: BASE_DIR + "icons/apple-launch-640x1136.png" }],
26+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 320px) and (device-height: 568px) and (-webkit-device-pixel-ratio: 2)', href: BASE_DIR + 'icons/head/apple-launch-640x1136.png' }],
2727
// iPad Mini, Air, 9.7
28-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 768px) and (device-height: 1024px) and (-webkit-device-pixel-ratio: 2)", href: BASE_DIR + "icons/apple-launch-1536x2048.png" }],
28+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 768px) and (device-height: 1024px) and (-webkit-device-pixel-ratio: 2)', href: BASE_DIR + 'icons/head/apple-launch-1536x2048.png' }],
2929
// iPad Pro 10.5
30-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 834px) and (device-height: 1112px) and (-webkit-device-pixel-ratio: 2)", href: BASE_DIR + "icons/apple-launch-1668x2224.png" }],
30+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 834px) and (device-height: 1112px) and (-webkit-device-pixel-ratio: 2)', href: BASE_DIR + 'icons/head/apple-launch-1668x2224.png' }],
3131
// iPad Pro 11
32-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 834px) and (device-height: 1194px) and (-webkit-device-pixel-ratio: 2)", href: BASE_DIR + "icons/apple-launch-1668x2388.png" }],
33-
// iPad Pro 12.9"
34-
['link', { rel: "apple-touch-startup-image", media: "(device-width: 1024px) and (device-height: 1366px) and (-webkit-device-pixel-ratio: 2)", href: BASE_DIR + "icons/apple-launch-2048x2732.png" }],
32+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 834px) and (device-height: 1194px) and (-webkit-device-pixel-ratio: 2)', href: BASE_DIR + 'icons/head/apple-launch-1668x2388.png' }],
33+
// iPad Pro 12.9'
34+
['link', { rel: 'apple-touch-startup-image', media: '(device-width: 1024px) and (device-height: 1366px) and (-webkit-device-pixel-ratio: 2)', href: BASE_DIR + 'icons/head/apple-launch-2048x2732.png' }],
3535

3636
// PWA
3737
['link', { rel: 'manifest', href: BASE_DIR + 'manifest.json' }],
3838
['meta', { name: 'theme-color', content: 'white' }],
3939
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
4040
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
4141
['meta', { name: 'apple-mobile-web-app-title', content: 'Hyperion Documentation' }],
42-
['link', { rel: 'apple-touch-icon', sizes: '120x120', href: BASE_DIR + 'icons/apple-icon-120x120.png' }],
43-
['link', { rel: 'apple-touch-icon', sizes: '152x152', href: BASE_DIR + 'icons/apple-icon-152x152.png' }],
44-
['link', { rel: 'apple-touch-icon', sizes: '167x167', href: BASE_DIR + 'icons/apple-icon-167x167.png' }],
45-
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: BASE_DIR + 'icons/apple-icon-180x180.png' }],
46-
['link', { rel: 'mask-icon', href: BASE_DIR + 'icons/safari-pinned-tab.svg', color: '#fff' }],
47-
['meta', { name: 'msapplication-TileImage', content: BASE_DIR + 'icons/ms-icon-144x144.png' }], // probably invert
42+
['link', { rel: 'apple-touch-icon', sizes: '120x120', href: BASE_DIR + 'icons/head/apple-icon-120x120.png' }],
43+
['link', { rel: 'apple-touch-icon', sizes: '152x152', href: BASE_DIR + 'icons/head/apple-icon-152x152.png' }],
44+
['link', { rel: 'apple-touch-icon', sizes: '167x167', href: BASE_DIR + 'icons/head/apple-icon-167x167.png' }],
45+
['link', { rel: 'apple-touch-icon', sizes: '180x180', href: BASE_DIR + 'icons/head/apple-icon-180x180.png' }],
46+
['link', { rel: 'mask-icon', href: BASE_DIR + 'icons/head/safari-pinned-tab.svg', color: '#fff' }],
47+
['meta', { name: 'msapplication-TileImage', content: BASE_DIR + 'icons/head/ms-icon-144x144.png' }], // probably invert
4848
['meta', { name: 'msapplication-TileColor', content: 'white' }] // might not match with icon
4949
]

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

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,14 @@ export const navbar_DE: any = [
4444
},
4545
{
4646
text: 'Json API',
47-
items: [
48-
{
49-
text: 'JSON',
50-
items: [
51-
{ text: "JSON-RPC Einführung", link: '/de/json/JSON.md' },
52-
{ text: "Server Informationen", link: '/de/json/ServerInfo.md' },
53-
{ text: "Steuerung", link: '/de/json/Control.md' },
54-
{ text: "Authentifizierung", link: '/de/json/Authentication.md' },
55-
{ text: "Abonnement", link: '/de/json/Subscribe.md' }
56-
]
57-
},
58-
{
59-
text: 'Sonstiges',
60-
items: [
61-
{ text: "Hyperion finden", link: '/de/api/Detect.md' },
62-
{ text: "Leitfaden", link: '/de/api/Guidelines.md' }
63-
]
64-
}
65-
]
47+
link: 'https://api.hyperion-project.org'
48+
},
49+
{
50+
text: "Forum",
51+
link: 'https://hyperion-project.org'
52+
},
53+
{
54+
text: "Changelogs",
55+
link: 'changelogs/index.md'
6656
}
6757
]

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

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -43,26 +43,15 @@ export const navbar_EN: any = [
4343
]
4444
},
4545
{
46-
text: "Json API",
47-
items: [
48-
{
49-
text: "JSON",
50-
items: [
51-
{ text: "JSON RPC Introduction", link: '/json/JSON.md' },
52-
{ text: "Server Information", link: '/json/ServerInfo.md' },
53-
{ text: "Control", link: '/json/Control.md' },
54-
{ text: "Authentication", link: '/json/Authentication.md' },
55-
{ text: "Subscription", link: '/json/Subscribe.md' }
56-
]
57-
},
58-
{
59-
text: "Miscellaneous",
60-
items: [
61-
{ text: "Detect Hyperion", link: '/api/Detect.md' },
62-
{ text: "Guidelines", link: '/api/Guidelines.md' }
63-
]
64-
},
65-
]
46+
text: 'Json API',
47+
link: 'https://api.hyperion-project.org'
6648
},
67-
{ text: "Forum", link: 'https://hyperion-project.org' }
49+
{
50+
text: "Forum",
51+
link: 'https://hyperion-project.org'
52+
},
53+
{
54+
text: "Changelogs",
55+
link: 'changelogs/index.md'
56+
}
6857
]

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

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -103,33 +103,5 @@ export const sidebar_DE: any = {
103103
{ text: "Grafische Benutzeroberfläche", link: '/de/api/Ui.md' }
104104
]
105105
}
106-
],
107-
"/de/json/": [
108-
{
109-
text: 'JSON',
110-
items: [
111-
{ text: "JSON-RPC Einführung", link: '/de/json/JSON.md' },
112-
{ text: "Server Informationen", link: '/de/json/ServerInfo.md' },
113-
{ text: "Steuerung", link: '/de/json/Control.md' },
114-
{ text: "Authentifizierung", link: '/de/json/Authentication.md' },
115-
{ text: "Abonnement", link: '/de/json/Subscribe.md' }
116-
]
117-
},
118-
{
119-
text: 'Sonstiges',
120-
items: [
121-
{ text: "Hyperion finden", link: '/de/api/Detect.md' },
122-
{ text: "Leitfaden", link: '/de/api/Guidelines.md' }
123-
]
124-
}
125-
],
126-
"/de/api/": [
127-
{
128-
text: 'Gehe zurück zu',
129-
items: [
130-
{ text: "Effekt-Erstellung", link: '/de/effects/Effects.md' },
131-
{ text: "JSON-RPC Einführung", link: '/de/json/JSON.md' }
132-
]
133-
}
134106
]
135107
}

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

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -103,33 +103,5 @@ export const sidebar_EN: any = {
103103
{ text: "Graphical User Interface", link: '/api/Ui.md' }
104104
]
105105
}
106-
],
107-
"/json/": [
108-
{
109-
text: 'JSON',
110-
items: [
111-
{ text: "JSON RPC Introduction", link: '/json/JSON.md' },
112-
{ text: "Server Information", link: '/json/ServerInfo.md' },
113-
{ text: "Control", link: '/json/Control.md' },
114-
{ text: "Authentication", link: '/json/Authentication.md' },
115-
{ text: "Subscription", link: '/json/Subscribe.md' }
116-
]
117-
},
118-
{
119-
text: 'Misc',
120-
items: [
121-
{ text: "Detect Hyperion", link: '/api/Detect.md' },
122-
{ text: "Guidelines", link: '/api/Guidelines.md' }
123-
]
124-
}
125-
],
126-
"/api/": [
127-
{
128-
text: 'Go back to',
129-
items: [
130-
{ text: "Effect development", link: '/effects/Effects.md' },
131-
{ text: "JSON RPC Introduction", link: '/json/JSON.md' }
132-
]
133-
}
134106
]
135107
}

‎docs/.vitepress/theme/components/ChangelogList.vue‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<script setup lang="ts">
2+
import MarkdownIt from 'markdown-it'
3+
import { data as changelogs } from '../data/changelogs.data.mts'
4+
import Contributors from './Contributors.vue'
5+
6+
const dateFormatter = new Intl.DateTimeFormat('en', {
7+
dateStyle: 'medium',
8+
})
9+
</script>
10+
11+
<template>
12+
<div
13+
v-for="(release, index) of changelogs"
14+
:key="release.tag_name"
15+
>
16+
<h2 :id="index === 0 ? 'latest' : release.tag_name">
17+
<a
18+
:href="release.html_url"
19+
target="_blank"
20+
>
21+
{{ release.tag_name }}
22+
</a>
23+
<Badge v-if="index === 0" type="tip" text="Latest" />
24+
<a
25+
class="header-anchor"
26+
:href="index === 0 ? '#latest' : `#${release.tag_name}`"
27+
/>
28+
</h2>
29+
<time :datetime="release.published_at!">
30+
{{ dateFormatter.format(new Date(release.published_at!)) }}
31+
</time>
32+
<div v-html="MarkdownIt().render(release.body ?? 'No changelog provided.')" />
33+
<Contributors
34+
:body="release.body!"
35+
:author="release.author.login"
36+
:tag="release.tag_name"
37+
/>
38+
</div>
39+
</template>
40+
41+
<style scoped>
42+
h2 {
43+
margin-bottom: 0;
44+
display: flex;
45+
align-items: center;
46+
gap: 0.5rem;
47+
> a {
48+
color: var(--vp-c-brand-1);
49+
}
50+
}
51+
52+
time {
53+
font-size: 0.875rem;
54+
color: var(--vp-c-text-2);
55+
}
56+
</style>

0 commit comments

Comments
 (0)