Administrator/Twitch-VOD-Manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Add Astro + MDX docs workspace

Browse Source 
Create a separate docs project with Astro and MDX so product documentation can evolve independently from the Electron app while supporting the planned TS/MDX migration.
This commit is contained in:
xRangerDE 2026-02-13 10:00:12 +01:00
parent eaa6d637ff
commit 301132c9ee
10 changed files with 6315 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.gitignore vendored
View File

@ -19,6 +19,11 @@ download_queue.json
.vscode/
.idea/
# Docs workspace
docs/node_modules/
docs/dist/
docs/.astro/
# Executables
Twitch_VOD_Manager.exe
server_files/*.exe

14
docs/README.md Normal file
View File

@ -0,0 +1,14 @@
# Docs (Astro + MDX)
## Start
```bash
npm install
npm run dev
```
## Build
```bash
npm run build
```

7
docs/astro.config.mjs Normal file
View File

@ -0,0 +1,7 @@
import { defineConfig } from 'astro/config';
import mdx from '@astrojs/mdx';
export default defineConfig({
integrations: [mdx()],
site: 'https://github.com/Sucukdeluxe/Twitch-VOD-Manager'
});

6199
docs/package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

15
docs/package.json Normal file
View File

@ -0,0 +1,15 @@
{
"name": "twitch-vod-manager-docs",
"private": true,
"version": "0.1.0",
"type": "module",
"scripts": {
"dev": "astro dev",
"build": "astro build",
"preview": "astro preview"
},
"dependencies": {
"@astrojs/mdx": "^4.3.0",
"astro": "^5.5.0"
}
}

22
docs/src/layouts/BaseLayout.astro Normal file
View File

@ -0,0 +1,22 @@
---
import '../styles/global.css';
interface Props {
title: string;
}
const { title } = Astro.props;
---
<html lang="de">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>{title}</title>
</head>
<body>
<main class="container">
<slot />
</main>
</body>
</html>

11
docs/src/pages/index.astro Normal file
View File

@ -0,0 +1,11 @@
---
import BaseLayout from '../layouts/BaseLayout.astro';
---
<BaseLayout title="Twitch VOD Manager Docs">
<h1>Twitch VOD Manager Documentation</h1>
<p>Die Dokumentation wird jetzt mit Astro + MDX gepflegt.</p>
<ul>
<li><a href="/roadmap">Migration Roadmap</a></li>
</ul>
</BaseLayout>

17
docs/src/pages/roadmap.mdx Normal file
View File

@ -0,0 +1,17 @@
---
layout: ../layouts/BaseLayout.astro
title: Migration Roadmap
---
# Migration Roadmap
## UI Stack
- Renderer wird schrittweise von HTML-Monolith zu TypeScript-Modulen migriert.
- Styles sind bereits in eine eigene CSS-Datei ausgelagert.
## Nächste Schritte
1. Renderer in weitere Feature-Module aufteilen (Cutter/Merge/Clips).
2. Komponenten-Ansatz einführen (Astro UI docs, später optional Rust-backend tooling).
3. API- und Release-Prozess in MDX dokumentieren.

22
docs/src/styles/global.css Normal file
View File

@ -0,0 +1,22 @@
:root {
color-scheme: dark;
font-family: 'Segoe UI', Tahoma, sans-serif;
background: #101216;
color: #f2f4f8;
}
body {
margin: 0;
min-height: 100vh;
background: radial-gradient(circle at top, #1a2330 0%, #101216 55%);
}
.container {
max-width: 860px;
margin: 0 auto;
padding: 40px 20px;
}
a {
color: #5ca3ff;
}

3
docs/tsconfig.json Normal file
View File

@ -0,0 +1,3 @@
{
"extends": "astro/tsconfigs/strict"
}