Exemplos

Trechos prontos para copiar dos fluxos comuns do scribe-cms.

Instalação

Adicione o scribe-cms a qualquer projeto Node 20+.

pnpm add scribe-cms zod better-sqlite3

Config

Defina tipos de conteúdo com Zod — campos traduzíveis, estruturais e de relação.

import { z } from "zod";
import { defineConfig, defineContentType, field } from "scribe-cms";

const blogSchema = z.object({
title: field.translatable(z.string().min(1)),
description: field.translatable(z.string().min(50)),
author: field.relation("author"),
});

const authorSchema = z.object({
name: field.structural(z.string().min(1)),
});

export default defineConfig({
  rootDir: ".",
  locales: ["en", "fr"],
  types: [
    defineContentType({
      id: "blog",
      path: "/blog/{slug}",
      schema: blogSchema,
      slugStrategy: "localized",
    }),
    defineContentType({
      id: "author",
      contentDir: "authors",
      schema: authorSchema,
    }),
  ],
});

Arquivo de conteúdo

Um arquivo .mdx por documento — o nome do arquivo é o slug em inglês.

---
title: "Olá, mundo"
description: "Um primeiro post que diz olá ao mundo, de forma extensa, porque o schema exige cinquenta caracteres."
author: jane
publishedAt: "2026-01-15"
---

O corpo é MDX. Tanto o **Markdown** quanto os componentes funcionam.

Runtime

Leia o conteúdo com um cliente tipado — liste, resolva e siga relacionamentos.

import { createScribe } from "scribe-cms/runtime";
import config from "./scribe.config";

const scribe = createScribe(config);

const posts = scribe.blog.list("fr");
const { document } = scribe.blog.resolve("hello-world", "fr");
const author = scribe.blog.related(document!, "author");

CLI

Valide o conteúdo antes dos builds e traduza páginas desatualizadas com o Gemini.

scribe validate
scribe translate --locale fr
scribe status