ScribeTypisiertes MDX-CMS

Erste Schritte

Installieren Sie scribe-cms, definieren Sie Ihr Schema, schreiben Sie Inhalte, validieren Sie diese und lesen Sie sie zur Laufzeit aus.

1. Installation

Fügen Sie scribe-cms und die zugehörigen Peer-Dependencies zu Ihrem Projekt hinzu.

2. scribe.config.ts erstellen

Definieren Sie Ihre Inhaltstypen mit Zod-Schemata im Hauptverzeichnis Ihres Projekts. Verwenden Sie `field.translatable()` für Felder, die übersetzt werden sollen, `field.structural()` für rein englische Felder und `field.relation()` für Verweise zwischen Dokumenten.

3. Inhalte verfassen

Erstellen Sie `.mdx`-Dateien im Verzeichnis `content/`. Der Dateiname entspricht dem englischen Slug. Das Frontmatter wird beim Laden anhand Ihres Schemas validiert.

4. Validierung

Führen Sie vor dem Build-Prozess `scribe validate` aus, um Schema-Fehler, fehlerhafte Verweise und Inkonsistenzen in den Übersetzungen zu erkennen.

5. Zur Laufzeit auslesen

Importieren Sie `createScribe` aus `scribe-cms/runtime`, übergeben Sie Ihre Konfiguration und nutzen Sie typisierte Methoden wie `scribe.blog.list()` und `scribe.blog.resolve(slug, locale)`.

Auf der Seite Beispiele finden Sie Snippets zum Kopieren und Einfügen.

Erste Schritte · Scribe