Scribe型付き MDX CMS

はじめに

scribe-cmsのインストールから、スキーマの定義、コンテンツの作成、バリデーション、そしてランタイムでの読み込みまでの手順を説明します。

1. インストール

プロジェクトにscribe-cmsとピア依存パッケージを追加します。

2. scribe.config.tsの作成

プロジェクトのルートで、Zodスキーマを使用してコンテンツタイプを定義します。翻訳対象のフィールドには`field.translatable()`、英語のみのフィールドには`field.structural()`、ドキュメント間の参照には`field.relation()`を使用します。

3. コンテンツの作成

`content/`ディレクトリ配下に`.mdx`ファイルを作成します。ファイル名が英語のslugとして扱われます。Frontmatterは、読み込み時にスキーマに沿ってバリデーションされます。

4. バリデーション

ビルド前に`scribe validate`を実行し、スキーマエラー、リレーションのリンク切れ、翻訳ストアの不整合を検出します。

5. ランタイムでの読み込み

`scribe-cms/runtime`から`createScribe`をインポートして設定を渡し、`scribe.blog.list()`や`scribe.blog.resolve(slug, locale)`のような型安全なアクセサーを使用します。

コピー&ペーストで使えるスニペットについては、Examplesページを参照してください。

はじめに · Scribe