Repolode
提交项目
sdorra

sdorra/content-collections

一款 TypeScript 工具，可将本地 Markdown、MDX、JSON 和 YAML 文件转换为类型安全的数据集合。

在 GitHub 查看官网
Star
1,203
Fork
53
未关闭 Issue
54
最近提交
22小时前

这是什么？

Content Collections 会读取目录中的文件，并将其转换为带类型的数据集合，应用可以直接导入使用。无需编写抓取和解析内容的代码，只需在配置文件中用 schema 定义集合即可，内容会在构建阶段完成解析和校验。

schema 会校验每个条目，字段错误或缺失会在构建时被发现。条目进入应用前还可以做转换，例如渲染 Markdown、合并多个集合或从服务端获取数据。开发时修改内容，集合会自动更新，无需重启服务或刷新浏览器。

项目为 Next.js、Remix（Vite）、SvelteKit、Solid Start、Qwik 和 Vite 提供适配器，其他框架可以通过 CLI 使用。

核心功能

  • 01通过配置文件和 schema 定义带类型的内容集合。
  • 02在构建阶段校验内容，尽早发现错误。
  • 03开发时内容变更后集合自动更新。
  • 04支持在内容进入应用前进行转换。
  • 05为多个框架提供适配器，并提供 CLI 供其他框架使用。

适用场景

  • 在 Next.js 或 SvelteKit 项目中基于 Markdown 或 MDX 文件构建博客或文档站。
  • 在 Vite 应用中以带类型的对象形式加载结构化的 YAML 或 JSON 数据。
  • 对内容目录进行校验，让格式错误的条目导致构建失败。

快速上手

  1. 1

    选择框架适配器，并按 README 中的链接安装

  2. 2

    在项目根目录创建 content-collections.ts 文件，定义你的内容集合

  3. 3

    在集合目录中编写 Markdown 内容，然后在应用中导入生成的集合

收录于专题

静态网站生成器与文档工具

标签

#content#typescript#markdown#mdx#type-safety#static-site#content-management#collections#content-layer#json

常见问题

content-collections 是什么？
一款 TypeScript 工具，可将本地 Markdown、MDX、JSON 和 YAML 文件转换为类型安全的数据集合。 Content Collections 会读取目录中的文件，并将其转换为带类型的数据集合，应用可以直接导入使用。无需编写抓取和解析内容的代码，只需在配置文件中用 schema 定义集合即可，内容会在构建阶段完成解析和校验。
content-collections 可以免费使用吗？用的什么许可证？
content-collections 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
content-collections 还在维护吗？
活跃维护中。content-collections 最近一次提交是在 2026年11月6日。
content-collections 适合用来做什么？
在 Next.js 或 SvelteKit 项目中基于 Markdown 或 MDX 文件构建博客或文档站。 在 Vite 应用中以带类型的对象形式加载结构化的 YAML 或 JSON 数据。 对内容目录进行校验，让格式错误的条目导致构建失败。
content-collections 怎么安装和运行？
选择框架适配器，并按 README 中的链接安装 在项目根目录创建 content-collections.ts 文件，定义你的内容集合 在集合目录中编写 Markdown 内容，然后在应用中导入生成的集合
在哪里获取 content-collections？
源代码和安装说明在 GitHub 上：https://github.com/sdorra/content-collections

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目