Headless Docs/Blog Kit (MDX + Suche + i18n) — Entwickler-Doku & Blog im Baukasten (Quellcode)

Docs, Blog & Changelog – produktionsreif ab Tag 1: MDX-basierter Content, schnelle Volltextsuche ohne Server, mehrsprachig (i18n) und Deploy-fertig.

Highlights

• MDX-first: Schreibe in Markdown, nutze React-Komponenten (Callouts, Tabs, Steps, Video, Merkmale).

• Volltextsuche lokal: Buildgenerierter Index (lunr/meilisearch-lite) – funktioniert statisch, ohne externe Dienste.

• i18n out of the box: Mehrsprachige Routen, Locale-Switcher, Fallbacks, übersetzte Meta-Tags & Sitemaps.

• Versionierte Doku: Mehrere Doc-Versionen (z. B. v1/v2) inkl. Version-Switcher, automatische Backport-Hinweise.

• UX für Dev-Dokus: Autogenerierte Sidebar/ToC, Breadcrumbs, „Zurück nach oben“, Ankerlinks, „Copy code“-Button, Keyboard-Shortcuts (/, n, p).

• SEO & Social: Saubere URLs, Open-Graph-Images, Canonicals, RSS/Atom, robots.txt & dynamische Sitemaps.

• Theming & Dark Mode: Tailwind-Designsystem, Light/Dark/Auto, individuell brandbar.

• Qualität & CI: Link-Checker, Linting für MD/MDX, Broken-Image-Prüfung, Previews via PR/Branch.

Für wen?

Developer-Teams, API-/SDK-Docs, technische Blogs, Open-Source-Projekte, Produktwebsites mit changeloggetriebener Kommunikation.

So funktioniert’s

1. Content anlegen: content/{locale}/{section}/{slug}.mdx (Frontmatter: Titel, Order, Tags, Version).

2. Navigation & Suche: Sidebar aus Ordnerstruktur, Suchindex beim Build generiert.

3. Mehrsprachigkeit: Texte/MDX pro Sprache, gemeinsame Medien; Locale-Switcher im Header.

4. Deploy: npm run build → statisch auf Vercel/Netlify/Nginx ausspielen.

Lieferumfang (Download, ZIP)

• Voller Quellcode: Next.js + MDX + Tailwind + (lunr/meilisearch-lite)

• Komponentensammlung: Callout, Tabs, Steps, CodeBlock (Shiki/Prism), Image, Video, Cards, Badge, Table

• i18n-Setup: next-intl/next-i18next-Konfig, Locale-Routing, Übersetzungsdateien

• Docs-Features: Version-Switcher, Changelog-Vorlage, Autor:innen/Tags, verwandte Artikel

• Build-Tools: Indexer für Suche, Link-Checker, Sitemap/robots/RSS-Generator

• Beispielinhalte: Mehrsprachige Docs & Blog, fertig verlinkte Sidebar

• CI-Vorlagen: GitHub Actions (Build, Link-Check, Preview), Dockerfile

• README & Doku: Quickstart (<10 Min), Struktur-Guides, Theming-Anleitung, Migrationshinweise

Technische Daten

• Stack: Next.js (App Router), MDX, Tailwind, TypeScript

• Suche: Generiert statisch – keine externen Keys/Dienste erforderlich

• i18n: Locale-Routen, Domains/Prefixes, Fallback-Logik, übersetzte Meta/Sitemap

• Performance: Bild-Optimierung, Routen-Prefetch, Caching, ESM-Bundles

• Zugänglichkeit: ARIA-Labels, Fokuszustände, Kontrast-Checks

Recht & Nutzung

• Einmalzahlung, kompletter Quellcode. 6 Monate Nutzungslizenz. Eigene Nutzung & Anpassung für private/geschäftliche Projekte. Kein DRM.

FAQ

Brauche ich ein Headless-CMS?
Nein. Das Kit ist filesystem-basiert. Späteres Andocken an ein CMS (z. B. Contentlayer/Contentful) ist möglich.

Wie groß kann die Site werden?
Auch große Dokus: Suchindex wird beim Build erzeugt; Pagination, Tag-Seiten & On-Demand-Revalidation sind vorbereitet.

Kann ich Algolia nutzen?
Ja, optional. Ein Adapter ist enthalten – out-of-the-box läuft’s aber ohne Drittanbieter.

Unterstützt ihr Mermaid/Diagramme?
Ja, über MDX-Komponenten (optional aktivierbar).

Wie passe ich das Design an?
Tailwind-Tokens in tailwind.config.ts + Theme-Variablen; Logos/OG-Styles in /app/(site)/theme.