Überblick Guides
Willkommen bei den ContentKit Guides. Dieser Abschnitt führt dich durch Installation, Konfiguration und Integration von ContentKit in deine TypeScript / Next.js Projekte und erklärt anschließend die erzeugten Artefakte.
ContentKit ist früh und in aktiver Entwicklung. APIs können sich ändern; pinne Versionen und lies Release Notes beim Upgraden.
Quick Start (TL;DR)
- Installieren:
pnpm add -D contentkit - Config initialisieren:
npx contentkit init - Markdown in deinem
content/Verzeichnis hinzufügen - Build:
npx contentkit build - Daten importieren:
import { allPosts } from 'dot-contentkit/generated'
Springe in die detaillierten Guides unten für tiefere Erklärungen und Optionen.
Zentrale Guides
- Installation – Paket hinzufügen & Config scaffolden.
- Konfiguration – Dokumenttypen, Felder & Computed Fields definieren.
- CLI – Commands (
init,validate,build) und Scripting-Tipps. - Build Output – Ordnerlayout, Imports & Typen.
Konzepte im Überblick
| Konzept | Was es ist | Wo lesen |
|---|---|---|
| Document Type | Schema für eine Gruppe von Markdown-Dateien | Konfiguration |
| Frontmatter | Quell-Metadaten (YAML / TOML / JSON) | Konfiguration / Output |
| Computed Field | Abgeleiteter Wert (slug, reading time, etc.) | Konfiguration |
| Generated Package | dot-contentkit virtueller Import mit Daten & Typen | Build Output |
Roadmap (High Level)
Geplant / in Exploration:
- Inkrementelle (per‑Datei) Builds
- Reichere MD/MDX Processing-Pipeline (Plugins / remark / rehype opt-in)
- Watch Mode außerhalb von Next.js
- Optionale Bild/Asset-Metadaten Extraktion
- Verbesserte DX für typsichere Custom Computed Fields
Feedback / Issues
Wenn etwas unklar oder kaputt ist, öffne ein Issue oder PR. Frühes Nutzerfeedback bestimmt stark die Prioritäten.
Viel Erfolg beim Bauen!