Seed 文件格式

Seed 文件是初始化 EmDash 站点的 JSON 文档。它们定义集合、字段、分类法、菜单、重定向、小部件区域、站点设置和可选的示例内容。

根结构

Seed 文件具有以下顶级结构：

{
	"$schema": "https://emdashcms.com/seed.schema.json",
	"version": "1",
	"meta": {},
	"settings": {},
	"collections": [],
	"taxonomies": [],
	"bylines": [],
	"menus": [],
	"redirects": [],
	"widgetAreas": [],
	"sections": [],
	"content": {}
}

Meta

meta 对象包含有关 seed 的可选描述性元数据：

{
	"meta": {
		"name": "Blog Starter",
		"description": "A simple blog with posts, pages, and categories",
		"author": "EmDash"
	}
}

Settings

settings 对象包含站点范围的配置值：

{
	"settings": {
		"title": "My Site",
		"tagline": "A modern CMS",
		"postsPerPage": 10,
		"dateFormat": "MMMM d, yyyy"
	}
}

设置应用于带有 site: 前缀的 options 表。设置向导将从 seed 文件（如果提供）预填充 title 和 tagline，允许用户在初始设置期间覆盖它们。

Collections

每个集合定义在数据库中创建一个内容类型：

{
	"collections": [
		{
			"slug": "posts",
			"label": "Posts",
			"labelSingular": "Post",
			"description": "Blog posts",
			"icon": "file-text",
			"supports": ["drafts", "revisions"],
			"fields": [
				{
					"slug": "title",
					"label": "Title",
					"type": "string",
					"required": true
				},
				{
					"slug": "content",
					"label": "Content",
					"type": "portableText"
				},
				{
					"slug": "featured_image",
					"label": "Featured Image",
					"type": "image"
				}
			]
		}
	]
}

集合属性

字段属性

字段类型

Taxonomies

分类法是内容的分类系统：

{
	"taxonomies": [
		{
			"name": "category",
			"label": "Categories",
			"labelSingular": "Category",
			"hierarchical": true,
			"collections": ["posts"],
			"terms": [
				{ "slug": "news", "label": "News" },
				{ "slug": "tutorials", "label": "Tutorials" },
				{
					"slug": "advanced",
					"label": "Advanced Tutorials",
					"parent": "tutorials"
				}
			]
		},
		{
			"name": "tag",
			"label": "Tags",
			"labelSingular": "Tag",
			"hierarchical": false,
			"collections": ["posts"]
		}
	]
}

分类法属性

术语属性

Menus

menus 数组定义可从管理员编辑的导航菜单：

{
	"menus": [
		{
			"name": "primary",
			"label": "Primary Navigation",
			"items": [
				{ "type": "custom", "label": "Home", "url": "/" },
				{ "type": "page", "ref": "about" },
				{ "type": "custom", "label": "Blog", "url": "/posts" },
				{
					"type": "custom",
					"label": "External",
					"url": "https://example.com",
					"target": "_blank"
				}
			]
		}
	]
}

菜单项类型

菜单项属性

Bylines

署名档案与所有权（author_id）分开。定义一次可重用的署名身份，然后从内容条目引用它们。

{
	"bylines": [
		{
			"id": "editorial",
			"slug": "emdash-editorial",
			"displayName": "EmDash Editorial"
		},
		{
			"id": "guest",
			"slug": "guest-contributor",
			"displayName": "Guest Contributor",
			"isGuest": true
		}
	]
}

Redirects

redirects 数组定义在迁移后保留旧版 URL 的重定向规则：

{
	"redirects": [
		{ "source": "/old-about", "destination": "/about" },
		{ "source": "/legacy-feed", "destination": "/rss.xml", "type": 308 },
		{
			"source": "/category/news",
			"destination": "/categories/news",
			"groupName": "migration"
		}
	]
}

重定向属性

Widget Areas

widgetAreas 数组定义可配置的内容区域：

{
	"widgetAreas": [
		{
			"name": "sidebar",
			"label": "Main Sidebar",
			"description": "Appears on blog posts and pages",
			"widgets": [
				{
					"type": "component",
					"title": "Recent Posts",
					"componentId": "core:recent-posts",
					"props": { "count": 5 }
				},
				{
					"type": "menu",
					"title": "Quick Links",
					"menuName": "footer"
				},
				{
					"type": "content",
					"title": "About",
					"content": [
						{
							"_type": "block",
							"style": "normal",
							"children": [{ "_type": "span", "text": "Welcome to our site!" }]
						}
					]
				}
			]
		}
	]
}

小部件类型

内置组件

Sections

Sections 是编辑者通过 /section 斜杠命令插入到 Portable Text 字段中的可重用内容块：

{
	"sections": [
		{
			"slug": "hero-centered",
			"title": "Centered Hero",
			"description": "Full-width hero with centered heading and CTA button",
			"keywords": ["hero", "banner", "header", "landing"],
			"content": [
				{
					"_type": "block",
					"style": "h1",
					"children": [{ "_type": "span", "text": "Welcome to Our Site" }]
				},
				{
					"_type": "block",
					"children": [
						{ "_type": "span", "text": "Your compelling tagline goes here." }
					]
				}
			]
		}
	]
}

Section 属性

来自 seed 文件的 sections 标记为 source: "theme"，不能从管理界面删除。编辑者可以创建自己的 sections（source: "user"），并在编辑内容时插入任何 section 类型。

Content

content 对象包含按集合组织的示例内容条目：

{
	"content": {
		"posts": [
			{
				"id": "hello-world",
				"slug": "hello-world",
				"status": "published",
				"bylines": [
					{ "byline": "editorial" },
					{ "byline": "guest", "roleLabel": "Guest essay" }
				],
				"data": {
					"title": "Hello World",
					"content": [
						{
							"_type": "block",
							"style": "normal",
							"children": [{ "_type": "span", "text": "Welcome!" }]
						}
					],
					"excerpt": "Your first post."
				},
				"taxonomies": {
					"category": ["news"],
					"tag": ["welcome", "first-post"]
				}
			}
		],
		"pages": [
			{
				"id": "about",
				"slug": "about",
				"status": "published",
				"data": {
					"title": "About Us",
					"content": [
						{
							"_type": "block",
							"style": "normal",
							"children": [{ "_type": "span", "text": "About page content." }]
						}
					]
				}
			}
		]
	}
}

内容条目属性

Content References

使用 $ref: 前缀引用其他内容条目：

{
	"data": {
		"related_posts": ["$ref:another-post", "$ref:third-post"]
	}
}

$ref: 前缀在种子期间将 seed ID 解析为数据库 ID。

Media References

从 URL 包含图像：

{
	"data": {
		"featured_image": {
			"$media": {
				"url": "https://images.unsplash.com/photo-xxx",
				"alt": "Description of the image",
				"filename": "hero.jpg",
				"caption": "Photo by Someone"
			}
		}
	}
}

从 .emdash/media/ 包含本地图像：

{
	"data": {
		"featured_image": {
			"$media": {
				"file": "hero.jpg",
				"alt": "Description of the image"
			}
		}
	}
}

媒体属性

*需要 url 或 file 之一，但不能同时需要两者。

Applying Seeds Programmatically

对 CLI 工具或脚本使用 seed API：

import { applySeed, validateSeed } from "emdash/seed";
import seedData from "./.emdash/seed.json";

// 首先验证
const validation = validateSeed(seedData);
if (!validation.valid) {
	console.error(validation.errors);
	process.exit(1);
}

// 应用 seed
const result = await applySeed(db, seedData, {
	includeContent: true,
	onConflict: "skip",
	storage: myStorage,
	baseUrl: "http://localhost:4321",
});

console.log(result);
// {
//   collections: { created: 2, skipped: 0 },
//   fields: { created: 8, skipped: 0 },
//   taxonomies: { created: 2, terms: 5 },
//   bylines: { created: 2, skipped: 0 },
//   menus: { created: 1, items: 4 },
//   redirects: { created: 3, skipped: 0 },
//   widgetAreas: { created: 1, widgets: 3 },
//   settings: { applied: 3 },
//   content: { created: 3, skipped: 0 },
//   media: { created: 2, skipped: 0 }
// }

Apply 选项

Idempotency

种子可以安全地运行多次。按实体类型的冲突行为：

Validation

Seed 文件在应用之前进行验证：

import { validateSeed } from "emdash/seed";

const { valid, errors, warnings } = validateSeed(seedData);

if (!valid) {
	errors.forEach((e) => console.error(e));
}

warnings.forEach((w) => console.warn(w));

验证检查：

• 必需字段存在
• Slug 对其类型有效（集合和字段 slug 允许小写字母、数字和下划线；其他 slug 还允许连字符）
• 字段类型有效
• 引用指向现有内容
• 分层术语父级存在
• 重定向路径是安全的本地 URL
• 重定向源是唯一的
• 集合中没有重复的 slug

CLI Commands

.emdash/seed.json、package.json#emdash.seed 或 seed/seed.json 中的 seed 文件被内联到构建中，并在数据库为空时的第一个请求时应用。要将现有站点的架构（以及可选的其内容）导出为 seed 文件：

# `mkdir -p` 因为在新项目上 .emdash/ 可能还不存在
mkdir -p .emdash

# 将当前架构导出为 seed 文件
npx emdash export-seed > .emdash/seed.json

# 导出包含内容
npx emdash export-seed --with-content > .emdash/seed.json

Next Steps

• Creating Themes — 创建完整主题
• Themes Overview — 主题如何工作