内容集

将您的内容转换为类型安全数据收集 。 消除人工取取和解析数据的必要性。 只要输入你的内容并开始。 内建验证可确保您的数据的准确性。 在您的数据输入您的应用程序前进行预处理 .

特征

• 美丽的DX数字 : 内容集旨在提供愉快的用户体验. 它提供了一个无缝开发者的经验,无需重启服务器或刷新浏览器. 内容集在修改内容时会自动更新.

• 类型安全数字 : 您的内容在构建过程中被解析和验证,保证准确性和货币性. 内容收藏为访问您的内容提供了一个类型安全的 API .

• 简单使用数字 : 无需再手动获取并解析内容 。 只需导入并开始使用内容收藏. 它提供了一个简单的API,允许您集中精力构建您的应用程序.

• 转变数字 : 内容收藏允许您在内容输入您的应用程序前进行转换 。 您可以使用它来修改您的内容, 加入两个收藏, 甚至从服务器获取数据 .

安装

内容集提供各种适配器,能与通俗的网络框架无缝地融合. 安装过程取决于所选适配器:

• 下一个.js
• 齐克
• Remix (视频)
• 固态启动
• 斯维尔特基特
• 维特

如果您的框架未列出, 您仍可以通过使用 国 际。如果想要看到框架列出,请打开一张票.

使用量

1. 在项目根部创建内容收集.ts文件 :

   import { defineCollection, defineConfig } from "@content-collections/core";
   
   const posts = defineCollection({
     name: "posts",
     directory: "src/posts",
     include: "**/*.md",
     schema: (z) => ({
       title: z.string(),
       summary: z.string(),
       content: z.string(),
     }),
   });
   
   export default defineConfig({
     content: [posts],
   });
   

2. 开始写入内容 src/posts数字 :

   ---
   title: Hello World
   summary: This is my first post
   ---
   
   # Hello World
   
   This is my first post.
   

3. 在应用程序中使用您的内容 :

   import { allPosts } from "content-collections";
   
   export function Posts() {
     return (
       <ul>
         {allPosts.map((post) => (
           <li key={post._meta.path}>
             <a href={`/posts/${post._meta.path}`}>
               <h3>{post.title}</h3>
               <p>{post.summary}</p>
             </a>
           </li>
         ))}
       </ul>
     );
   }
   

   请注意,上述例子仅显示了内容集的基本内容,并不涵盖内容转换. 内容集不默认会改变内容如平分或mdx. 但它有包 可以为你做到这一点:

   • @ 内容收集/ 标记下
   • @ 内容收藏/ mdx

   如果您想要看到更多实例并使用实例,请参考 文档。 。 。 .

发起人

成为提案国

许可证

内容收集根据 MIT 许可证。 。 。 .