ScribeТипизированная MDX CMS

Начало работы

Установите scribe-cms, определите схему, напишите контент, выполните валидацию и получайте данные в рантайме.

1. Установка

Добавьте scribe-cms и его peer-зависимости в ваш проект.

2. Создайте scribe.config.ts

Определите типы контента с помощью схем Zod в корне вашего проекта. Используйте `field.translatable()` для полей, требующих перевода, `field.structural()` для непереводимых (EN-only) полей и `field.relation()` для связей между документами.

3. Написание контента

Создайте файлы `.mdx` в директории `content/`. Имя файла будет служить английским slug'ом. Frontmatter проверяется на соответствие вашей схеме во время загрузки.

4. Валидация

Запустите `scribe validate` перед сборкой, чтобы обнаружить ошибки в схеме, нарушенные связи и несоответствия в хранилище переводов.

5. Использование в рантайме

Импортируйте `createScribe` из `scribe-cms/runtime`, передайте ваш конфиг и используйте типизированные методы доступа, такие как `scribe.blog.list()` и `scribe.blog.resolve(slug, locale)`.

Смотрите страницу Примеры с готовыми фрагментами кода для копирования.

Начало работы · Scribe