内容集合 API 参考
添加于:
astro@2.0.0
内容集合提供了 API 来配置和查询 src/content/
中的 Markdown 或 MDX 文档。有关功能和用法示例,请参考内容集合指南。
从 astro:content
导入
段落标题 从 astro:content 导入defineCollection()
段落标题 defineCollection()类型:(input: CollectionConfig) => CollectionConfig
defineCollection()
是一个用于在 src/content/config.*
文件中配置集合的工具函数。
这个函数接受以下属性:
type
段落标题 type类型:'content' | 'data'
默认:'content'
astro@2.5.0
type
是一个字符串,用于定义存储在集合中的条目的类型:
'content'
- 用于内容创作格式,如 Markdown (.md
)、MDX (.mdx
) 或 Markdoc (.mdoc
)'data'
- 用于 JSON (.json
) 或 YAML (.yaml
) 等纯数据格式
这意味着集合不能存储内容和数据格式的混合。你必须按类型将这些条目分割成单独的集合。
schema
段落标题 schema类型:ZodType | (context: SchemaContext) => ZodType
schema
是一个可选的 Zod 对象,用于配置集合的文档 frontmatter 的类型和形状。每个值必须使用 Zod 验证器
有关示例请 参考 内容集合
指南。
reference()
段落标题 reference()类型:(collection: string) => ZodEffects<ZodString, { collection, id: string } | { collection, slug: string }>
astro@2.5.0
在内容配置中使用 reference()
函数来定义从一个集合到另一个集合的关系或 “引用”。该函数接受一个集合名称,并验证内容前置事项或数据文件中指定的条目标识符。
此示例定义了从博客作者到 “作者 “集合的引用,以及到同一 “博客 “集合的相关文章数组的引用:
有关示例请 参考 内容集合
指南。
getCollection()
段落标题 getCollection()类型: (collection: string, filter?: (entry: CollectionEntry<TCollectionName>) => boolean) => CollectionEntry<TCollectionName>[]
getCollection()
是一个函数,用于通过集合名称检索内容集合条目列表。
默认情况下,它返回集合中的所有项目,并接受可选的 filter
函数来缩小条目属性。这允许你根据 id
、slug
或 frontmatter 值(通过 data
对象)查询集合中的某些项目。
有关示例请 参考 内容集合
指南 以获取示例用法。
getEntry()
段落标题 getEntry()
添加于:
astro@2.5.0
类型:
(collection: string, contentSlugOrDataId: string) => CollectionEntry<TCollectionName>
({ collection: string, id: string }) => CollectionEntry<TCollectionName>
({ collection: string, slug: string }) => CollectionEntry<TCollectionName>
getEntry()
是一个函数,可通过集合名称和条目 id
(对于 type: 'data'
集合)或条目 slug
(对于 type: 'content'
集合)检索单个集合条目。getEntry()
也可用于获取引用条目,以访问data
、body
或render()
属性:
有关内容集合
的示例,请参考 查询集合条目。
getEntries()
段落标题 getEntries()
添加于:
astro@2.5.0
类型:
(Array<{ collection: string, id: string }>) => CollectionEntry<TCollectionName>[]
(Array<{ collection: string, slug: string }>) => CollectionEntry<TCollectionName>[]
getEntries()
是一个从同一集合中检索多个集合条目的函数。这对于返回引用条目的数组访问其关联的data
、body
和render()
属性非常有用。
getEntryBySlug()
段落标题 getEntryBySlug()类型: (collection: string, slug: string) => Promise<CollectionEntry<TCollectionName>>
使用 getEntry()
函数 查询内容条目。该函数接受与 getEntryBySlug()
相同的参数,并支持通过 id
查询 JSON 或 YAML 集合。
getEntryBySlug()
是一个函数,用于通过集合名称和条目 slug
检索单个集合条目。
有关示例请 参考内容集合
指南 以获取示例用法。
getDataEntryById()
段落标题 getDataEntryById()类型: (collection: string, id: string) => Promise<CollectionEntry<TCollectionName>>
astro@2.5.0
使用 getEntry()
函数 查询数据条目。该函数接受与 getDataEntryById()
相同的参数,并支持通过 slug
查询 Markdown 等内容创作格式的条目。
getDataEntryById()
是一个用于通过集合名称和条目 id
检索单个集合条目的函数。
astro:content
类型
段落标题 astro:content 类型CollectionEntry
段落标题 CollectionEntry查询函数包括 getCollection()
、getEntry()
和 getEntries()
,每个函数都会返回 CollectionEntry
类型的条目。这种类型可以作为 astro:content
中的实用程序使用:
CollectionEntry
是一个泛型类型。将其与你正在查询的集合的名称一起使用。
例如,blog
集合中的条目的类型为 CollectionEntry<'blog'>
。
每个 CollectionEntry
都是一个具有以下值的对象:
id
段落标题 id适用于: type: 'content'
和 type: 'data'
集合
示例类型:
- 内容集合:
'entry-1.md' | 'entry-2.md' | ...
- 数据集合:
'author-1' | 'author-2' | ...
一个使用相对于 src/content/[collection]
的文件路径的唯一 ID。根据集合条目文件路径枚举所有可能的字符串值。
请注意,类型: 'content'
的集合在其 ID 中包含文件扩展名,而定义为 type: 'data'
的集合则不包含。
collection
段落标题 collection适用于: type: 'content'
和 type: 'data'
集合
示例类型: 'blog' | 'authors' | ...
src/content/
下顶级文件夹的名称,条目位于该文件夹中。该名称用于在 schema 和查询函数中引用集合。
data
段落标题 data适用于: type: 'content'
和 type: 'data'
集合
类型:CollectionSchema<TCollectionName>
一个从集合模式推断出的 frontmatter 属性对象(参考 defineCollection()
)。如果没有配置模式,则默认为 any
。
slug
段落标题 slug适用于: 仅仅 type: 'content'
集合
示例类型: 'entry-1' | 'entry-2' | ...
可用于 Markdown 或 MDX 文档的 URL 标头。默认为不含文件扩展名的 “id”,但可以通过在文件的 frontmatter 中设置slug
属性来覆盖。
body
段落标题 body适用于: 仅 type: 'content'
集合
类型:string
一个包含 Markdown 或 MDX 文档原始未编译的 body 的字符串。
render()
段落标题 render()适用于: 仅 type: 'content'
集合
类型:() => Promise<RenderedEntry>
一个用于编译给定的 Markdown 或 MDX 文档以进行渲染的函数。它返回以下属性:
<Content />
- 用于在 Astro 文件中渲染文档内容的组件。headings
- 生成的标题列表,与 Astro 的getHeadings()
工具函数相同 在 Markdown 和 MDX 导入中。remarkPluginFrontmatter
- 在应用 remark 或 rehype 插件后修改后的 frontmatter 对象。设置为类型any
。
有关示例请 参考 内容集合
指南 以获取示例用法。
CollectionKey
段落标题 CollectionKey
添加于:
astro@3.1.0
这是一个在 src/content/config.*
文件中定义的所有集合名称的字符串联合类型。当定义一个可以接受任何集合名称的通用函数时,这个类型很有用。
ContentCollectionKey
段落标题 ContentCollectionKey
添加于:
astro@3.1.0
一个在 src/content/config.*
文件中定义的所有 type: 'content'
集合名称的字符串联合类型。
DataCollectionKey
段落标题 DataCollectionKey
添加于:
astro@3.1.0
一个在 src/content/config.*
文件中定义的所有 type: 'data'
集合名称的字符串联合类型。
SchemaContext
段落标题 SchemaContext即 defineCollection
在 schema
函数形状中所使用的 context
对象。当为多个集合构建可重用的模式时,这个类型很有用。
它包括了以下属性:
image
-image()
schema 辅助工具允许你 在内容集合中使用本地图片。