Scribe类型化 MDX CMS

快速开始

安装 scribe-cms,定义 schema,编写内容,验证数据并在运行时读取。

1. 安装

在你的项目中添加 scribe-cms 及其 peer dependencies。

2. 创建 scribe.config.ts

在项目根目录使用 Zod schema 定义内容类型。对需要翻译的字段使用 `field.translatable()`,仅英文生效的结构化字段使用 `field.structural()`,文档间引用则使用 `field.relation()`。

3. 编写内容

在 `content/` 目录下创建 `.mdx` 文件。文件名将作为英文 slug。加载时系统会根据你的 schema 自动验证 Frontmatter。

4. 验证

在构建前运行 `scribe validate` 命令,提前捕获 schema 错误、失效的关联引用以及翻译库中的不一致问题。

5. 运行时读取

从 `scribe-cms/runtime` 导入 `createScribe`,传入配置,即可使用具备完整类型支持的访问器,如 `scribe.blog.list()` 和 `scribe.blog.resolve(slug, locale)`。

前往 Examples 页面获取可供复制粘贴的代码示例。

快速开始 · Scribe