Merge pull request 'Feat/wiki' (#37) from feat/wiki into main
Deploy Next.js via Docker / deploy (push) Successful in 3m57s

Reviewed-on: Schanbro/PsalmTafel#37
This commit was merged in pull request #37.
This commit is contained in:
robin committed 2026-08-05 10:58:32 +00:00
commit c4f29ef78b
12 files changed
+2217 -96

No files matched your search

+127
View File
@@ -29,3 +29,130 @@ section {
margin-bottom: 50px; margin-bottom: 50px;
} }
h1 {
font-size: 2rem;
}
/* Shiki Code-Blöcke stylen */
pre {
padding: 1rem;
border-radius: 0.75rem;
border: 1px solid #27272a; /* Tailwind zinc-800 */
overflow-x: auto;
font-size: 0.875rem;
}
pre code {
background-color: transparent !important;
padding: 0 !important;
border: none !important;
}
/* Shiki / Rehype Pretty Code Block Container */
figure[data-rehype-pretty-code-figure] {
margin-top: 1.5rem;
margin-bottom: 1.5rem;
border-radius: 0.75rem;
overflow: hidden;
border: 1px solid #27272a; /* Tailwind zinc-800 */
background-color: #0d1117; /* Dunkler VS-Code Hintergrund */
}
/* Der Titel/Dateiname (falls im MDX angegeben) */
div[data-rehype-pretty-code-title] {
background-color: #161b22;
border-bottom: 1px solid #27272a;
padding: 0.5rem 1rem;
font-family: monospace;
font-size: 0.75rem;
color: #8b949e;
}
/* Der eigentliche Code-Bereich */
figure[data-rehype-pretty-code-figure] pre {
margin: 0 !important;
padding: 1rem !important;
background-color: transparent !important;
overflow-x: auto;
font-size: 0.875rem;
line-height: 1.7;
}
figure[data-rehype-pretty-code-figure] code {
font-family: var(--font-mono, monospace);
}
/* Container für den Code-Block */
/* Container für den Code-Block */
figure[data-rehype-pretty-code-figure] {
position: relative;
margin-top: 1.5rem;
margin-bottom: 1.5rem;
border-radius: 0.75rem;
overflow: hidden;
border: 1px solid #27272a;
background-color: #0d1117;
}
/* Leeres Pseudo-Element der Figure deaktivieren */
figure[data-rehype-pretty-code-figure]::before {
display: none !important;
}
/* Sprach-Badge links oben */
figure[data-rehype-pretty-code-figure] pre[data-language]::before {
content: attr(data-language);
display: block !important;
position: absolute;
top: 0.6rem;
left: 0.5rem;
font-family: var(--font-mono, ui-monospace, monospace);
font-size: 0.68rem;
font-weight: 600;
text-transform: uppercase;
letter-spacing: 0.05em;
color: #a1a1aa;
background-color: #18181b;
border: 1px solid #27272a;
padding: 0.15rem 0.5rem;
border-radius: 0.375rem;
pointer-events: none;
z-index: 10;
}
/* Platz oben im Code-Block */
figure[data-rehype-pretty-code-figure] pre {
margin: 0 !important;
padding: 1rem !important;
padding-top: 2.6rem !important; /* Platz für Badge & Button */
background-color: transparent !important;
overflow-x: auto;
font-size: 0.875rem;
line-height: 1.7;
}
h1, h2, h3, h4, h5, h6 {
scroll-margin-top: 5rem; /* <-- Höhe deines Headers + etwas Abstand */
}
html {
scroll-behavior: smooth;
}
/* Anchor-Link Styling */
.heading-anchor {
opacity: 0;
margin-right: 1em; /* Abstand zum nachfolgenden Text */
color: #3b82f6; /* Tailwind blue-500 */
text-decoration: none;
font-weight: 800;
transition: opacity 0.15s ease-in-out;
}
h1:hover .heading-anchor,
h2:hover .heading-anchor,
h3:hover .heading-anchor,
h4:hover .heading-anchor,
.heading-anchor:focus {
opacity: 1;
}
+84
View File
@@ -0,0 +1,84 @@
import { getWikiPageBySlug } from '@/lib/wiki';
import { notFound } from 'next/navigation';
import { MDXRemote } from 'next-mdx-remote/rsc';
import rehypePrettyCode from 'rehype-pretty-code';
import rehypeSlug from 'rehype-slug';
import rehypeAutolinkHeadings from 'rehype-autolink-headings';
import { Callout, Grid, Card, Steps, Step, InlineCode, CodeBlockContainer } from '@/components/mdx-components';
const mdxOptions = {
mdxOptions: {
rehypePlugins: [
rehypeSlug, // creates heading-ids automaticly
[
rehypeAutolinkHeadings,
{
behavior: 'prepend', // symbol is PRE header
properties: {
className: ['heading-anchor'],
ariaHidden: 'true',
tabIndex: -1,
},
content: {
type: 'text',
value: ' #', // symbol
},
},
],
[
rehypePrettyCode,
{
theme: 'github-dark',
keepBackground: true,
},
],
],
},
};
const mdxComponents = {
// Eigene UI-Komponenten
Callout,
Grid,
Card,
Steps,
Step,
// Custom Typography Überschreibungen
code: InlineCode,
pre: CodeBlockContainer,
h1: (props: any) => <h1 className="text-3xl font-bold text-white mt-8 mb-4 border-b border-zinc-800 pb-3" {...props} />,
h2: (props: any) => <h2 className="text-2xl font-bold text-white mt-10 mb-4" {...props} />,
h3: (props: any) => <h3 className="text-xl font-semibold text-white mt-6 mb-3" {...props} />,
};
type PageProps = {
params: Promise<{
slug: string;
}>;
};
export default async function Page({ params }: PageProps) {
const { slug } = await params;
const article = await getWikiPageBySlug(slug);
if (!article) {
notFound();
}
return (
<article className="prose prose-invert prose-blue max-w-4xl mx-auto p-6 md:p-12 min-h-screen">
<header className="mb-8 border-b border-zinc-800 pb-6">
<h1 className="text-4xl font-extrabold text-white mb-2 m-0">{article.title}</h1>
{article.updatedAt && (
<p className="text-zinc-500 text-sm m-0">Zuletzt aktualisiert: {article.updatedAt}</p>
)}
</header>
<MDXRemote
source={article.rawContent}
components={mdxComponents}
options={mdxOptions as any}
/>
</article>
);
}
+45
View File
@@ -0,0 +1,45 @@
'use client';
import { useState } from 'react';
export function CopyButton({ code }: { code?: string }) {
const [copied, setCopied] = useState(false);
const handleCopy = async (e: React.MouseEvent<HTMLButtonElement>) => {
e.preventDefault();
// Falls kein expliziter Code übergeben wird, suchen wir den Text im Elternelement (Codeblock)
let textToCopy = code;
if (!textToCopy) {
const parent = e.currentTarget.closest('figure');
const codeElement = parent?.querySelector('code');
textToCopy = codeElement?.textContent || '';
}
if (textToCopy) {
await navigator.clipboard.writeText(textToCopy);
setCopied(true);
setTimeout(() => setCopied(false), 2000);
}
};
return (
<button
onClick={handleCopy}
className="absolute top-2.5 right-3 p-1.5 rounded-md bg-zinc-900 border border-zinc-800 text-zinc-400 hover:text-white hover:bg-zinc-800 transition-colors z-20"
aria-label="Code kopieren"
>
{copied ? (
// Check Icon (Erfolg)
<svg className="w-4 h-4 text-emerald-400" fill="none" viewBox="0 0 24 24" stroke="currentColor">
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M5 13l4 4L19 7" />
</svg>
) : (
// Clipboard Icon
<svg className="w-4 h-4" fill="none" viewBox="0 0 24 24" stroke="currentColor">
<path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M8 16H6a2 2 0 01-2-2V6a2 2 0 012-2h8a2 2 0 012 2v2m-6 12h8a2 2 0 002-2v-8a2 2 0 00-2-2h-8a2 2 0 00-2 2v8a2 2 0 002 2z" />
</svg>
)}
</button>
);
}
+119
View File
@@ -0,0 +1,119 @@
import React from 'react';
import { CopyButton } from './CopyButton';
// 1. Callouts (Info, Warning, Error, Success)
export function Callout({
children,
type = 'info'
}: {
children: React.ReactNode;
type?: 'info' | 'warning' | 'error' | 'success'
}) {
const variants = {
info: "bg-blue-500/10 border-blue-500 text-blue-200",
warning: "bg-amber-500/10 border-amber-500 text-amber-200",
error: "bg-red-500/10 border-red-500 text-red-200",
success: "bg-emerald-500/10 border-emerald-500 text-emerald-200",
};
return (
<div className={`p-4 my-6 rounded-xl border-l-4 ${variants[type]}`}>
<div className="flex gap-3 items-start">
<div className="mt-0.5 shrink-0">
{type === 'info' && <svg className="w-5 h-5 text-blue-400" fill="none" viewBox="0 0 24 24" stroke="currentColor"><path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M13 16h-1v-4h-1m1-4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg>}
{type === 'warning' && <svg className="w-5 h-5 text-amber-400" fill="none" viewBox="0 0 24 24" stroke="currentColor"><path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z" /></svg>}
{type === 'error' && <svg className="w-5 h-5 text-red-400" fill="none" viewBox="0 0 24 24" stroke="currentColor"><path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M12 8v4m0 4h.01M21 12a9 9 0 11-18 0 9 9 0 0118 0z" /></svg>}
{type === 'success' && <svg className="w-5 h-5 text-emerald-400" fill="none" viewBox="0 0 24 24" stroke="currentColor"><path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M5 13l4 4L19 7" /></svg>}
</div>
<div className="text-sm leading-relaxed [&>p]:m-0">{children}</div>
</div>
</div>
);
}
// 2. Grid & Cards
export function Grid({ children }: { children: React.ReactNode }) {
return <div className="grid grid-cols-1 md:grid-cols-2 gap-4 my-8">{children}</div>;
}
export function Card({ title, href, children }: { title: string; href: string; children: React.ReactNode }) {
return (
<a href={href} className="block p-6 bg-zinc-900 border border-zinc-800 rounded-xl hover:border-blue-500 transition-colors group no-underline">
<h3 className="text-lg font-bold text-white group-hover:text-blue-400 m-0 mb-2">{title}</h3>
<div className="text-zinc-400 text-sm m-0 leading-relaxed [&>p]:m-0">
{children}
</div>
</a>
);
}
// 3. Steps
export function Steps({ children }: { children: React.ReactNode }) {
// Wir gehen durch alle Kinder und fügen automatisch die 'stepNumber' als Prop hinzu
const steps = React.Children.map(children, (child, index) => {
if (React.isValidElement(child)) {
return React.cloneElement(child as React.ReactElement<any>, {
stepNumber: index + 1,
});
}
return child;
});
return (
<div className="ml-4 border-l border-zinc-800 pl-8 my-8 space-y-8">
{steps}
</div>
);
}
export function Step({
title,
children,
stepNumber
}: {
title: string;
children: React.ReactNode;
stepNumber?: number;
}) {
return (
<div className="relative">
{/* Die Nummer wird direkt als Text aus React gerendert */}
<div className="absolute -left-[41px] flex h-5 w-5 items-center justify-center rounded-full bg-zinc-900 border border-zinc-800 text-[10px] font-bold text-white">
{stepNumber}
</div>
<h3 className="text-white font-bold mb-2 mt-0 text-base">{title}</h3>
<div className="text-zinc-400 text-sm [&>p]:m-0">{children}</div>
</div>
);
}
// Custom Inline Code (verhindert das Erben auf große Codeblöcke)
export function InlineCode({ children, className, ...props }: React.HTMLAttributes<HTMLElement>) {
// Wenn 'data-theme' oder 'data-language' existiert, kommt das Element aus rehype-pretty-code (Code-Block)
const isCodeBlock = props && ('data-theme' in props || 'data-language' in props);
// Falls es Teil eines großen Codeblocks ist -> normales <code> ohne Inline-Styling rendern
if (isCodeBlock || className?.includes('language-')) {
return <code className={className} {...props}>{children}</code>;
}
// Ansonsten: Unser schickes Inline-Code-Design anwenden
return (
<code
className="px-1.5 py-0.5 rounded-md bg-zinc-800 text-pink-400 font-mono text-sm border border-zinc-700/50 before:content-none after:content-none"
{...props}
>
{children}
</code>
);
}
export function CodeBlockContainer({ children, ...props }: React.HTMLAttributes<HTMLPreElement>) {
return (
<div className="relative group">
<CopyButton />
<pre {...props}>{children}</pre>
</div>
);
}
+6
View File
@@ -0,0 +1,6 @@
---
title: API
updatedAt: "2026-08-05"
---
comming soon...
+34
View File
@@ -0,0 +1,34 @@
---
title: Lied erstellen
updatedAt: "2026-08-05"
---
<Steps>
<Step title="Verwaltungsseite aufrufen">
Navigiere im Browser auf `http://<ip>:3000/admin` (oder falls lokal gehostet: `http://localhost:3000/admin`).
</Step>
<Step title="Liederbuch auswählen">
Wähle in der Karte "Lied hinzufügen" oder "CSV-Massenimport" ein Liederbuch aus.
</Step>
<Step title="Lied hinzufügen">
Gib in der Karte "Lied hinzufügen" die Nummer und den Namen des Liedes ein. Bestätige mit "Lied speichern".
<img src="https://git.schamagusa.de/Schanbro/PsalmTafel/raw/branch/main/wiki/new_song.png" alt="Neues Lied hinzufügen" />
Alternativ in der Karte "CSV-Massenimport" eine CSV-Datei hochladen und mit "Hochladen & Verarbeiten" bestäigen.
<img src="https://git.schamagusa.de/Schanbro/PsalmTafel/raw/branch/main/wiki/csv_import.png" alt="CSV-Massenimport" />
<Callout type="important">
Das Format der CSV-Datei muss wie folgt aufgebaut sein:
```csv
nummer;title
[Lied-Nummer];[Lied-Titel]
```
**Beispiel:**
```csv
nummer;title
24;Die Schwalbe lieb und klein
596;Von guten Mächten wunderbar geborgen
```
</Callout>
</Step>
</Steps>
+14
View File
@@ -0,0 +1,14 @@
---
title: Liederbuch erstellen
updatedAt: "2026-08-05"
---
<Steps>
<Step title="Verwaltungsseite aufrufen">
Navigiere im Browser auf `http://<ip>:3000/admin` (oder falls lokal gehostet: `http://localhost:3000/admin`).
</Step>
<Step title="Liederbuch hinzufügen">
Gib in der Karte "Neues Liederbuch" die Namen und optional die Sprache des Liederbuchs ein. Bestätige mit "Liederbuch erstellen".
<img src="https://git.schamagusa.de/Schanbro/PsalmTafel/raw/branch/main/wiki/new_songbook.png" alt="Neues Liederbuch hinzufügen" />
</Step>
</Steps>
+49
View File
@@ -0,0 +1,49 @@
---
title: Installation & Setup
updatedAt: "2026-08-05"
----
<Callout type="warning">
Dieses Projekt befindet sich noch in der **aktiven Entwicklungsphase**. Bitte verwende es noch nicht für den produktiven Einsatz.
</Callout>
## Installation
<Steps>
<Step title="Repository klonen">
Nutze Git, um den Code zu holen:
```bash
git clone https://git.schamagusa.de/Schanbro/PsalmTafel.git
```
</Step>
<Step title="Navigiere in den erzeugten Ordner">
Nutze cd, um in den Ordner zu navigieren:
```bash
cd PsalmTafel
```
</Step>
<Step title="Abhängigkeiten installieren">
Führe den Installer aus:
```bash
npm install
```
</Step>
</Steps>
## Setup
<Steps>
<Step title="Datenbank einrichten lassen">
Führe die Einrichtung der Datenbank aus:
```bash
prisma generate
npx prisma migrate dev
```
</Step>
<Step title="Server starten">
Führe den Installer aus:
```bash
pnpm dev
```
</Step>
</Steps>
+42
View File
@@ -0,0 +1,42 @@
---
title: Projekt Starten
updatedAt: "2026-08-04"
---
Willkommen im offiziellen Wiki! Hier findest du alle Informationen zum Projekt.
<Grid>
<Card title="Installation" href="/wiki/installation">
Erfahre, wie du das Projekt lokal aufsetzt.
</Card>
<Card title="Deployment" href="/wiki/deployment">
So bringst du deinen Code live auf den Server.
</Card>
</Grid>
## Schnellstart
<Steps>
<Step title="Repository klonen">
Nutze Git, um den Code zu holen:
`git clone ...`
</Step>
<Step title="Abhängigkeiten installieren">
Führe den Installer aus:
`pnpm install`
</Step>
</Steps>
<Callout type="warning">
Vergiss nicht, die `.env` Datei anzulegen, sonst startet die App nicht!
</Callout>
<Callout type="success">
Du bist jetzt bereit zum Entwickeln!
</Callout>
```typescript
function sayHello(name: string): string {
return `Hallo, ${name}!`;
}
```
+32
View File
@@ -0,0 +1,32 @@
import fs from 'fs';
import path from 'path';
import matter from 'gray-matter';
export type WikiArticle = {
slug: string;
title: string;
rawContent: string;
updatedAt?: string;
};
const wikiDirectory = path.join(process.cwd(), "data/wiki/pages");
export async function getWikiPageBySlug(slug: string): Promise<WikiArticle | null> {
try {
const fullPath = path.join(wikiDirectory, `${slug}.mdx`);
const fileContents = fs.readFileSync(fullPath, "utf-8");
// Metadaten und Inhalt parsen
const { data, content } = matter(fileContents);
return {
slug,
rawContent: content,
title: data.title || 'Unbenannt',
updatedAt: data.updatedAt || null,
...data,
} as WikiArticle;
} catch (error) {
return null;
}
}
+14 -1
View File
@@ -11,13 +11,26 @@
"dependencies": { "dependencies": {
"@types/papaparse": "^5.5.2", "@types/papaparse": "^5.5.2",
"better-sqlite3": "^12.11.1", "better-sqlite3": "^12.11.1",
"gray-matter": "^4.0.3",
"next": "16.2.9", "next": "16.2.9",
"next-mdx-remote": "^6.0.0",
"papaparse": "^5.5.4", "papaparse": "^5.5.4",
"react": "19.2.4", "react": "19.2.4",
"react-dom": "19.2.4" "react-dom": "19.2.4",
"rehype-autolink-headings": "^7.1.0",
"rehype-highlight": "^7.0.2",
"rehype-pretty-code": "^0.14.5",
"rehype-slug": "^6.0.0",
"rehype-stringify": "^10.0.1",
"remark": "^15.0.1",
"remark-html": "^16.0.1",
"remark-parse": "^11.0.0",
"remark-rehype": "^11.1.2",
"shiki": "^4.4.1"
}, },
"devDependencies": { "devDependencies": {
"@tailwindcss/postcss": "^4", "@tailwindcss/postcss": "^4",
"@tailwindcss/typography": "^0.5.20",
"@types/better-sqlite3": "^7.6.13", "@types/better-sqlite3": "^7.6.13",
"@types/node": "^20", "@types/node": "^20",
"@types/react": "^19", "@types/react": "^19",
+1651 -95
View File
File diff suppressed because it is too large. Load diff