content collections

Coleções de conteúdo

Transforme seu conteúdo em coleções de dados seguras de tipo. Elimine a necessidade de busca e análise de dados manuais. Basta importar seu conteúdo e começar. A validação interna garante a precisão de seus dados. Pré -processo seus dados antes de entrar no seu aplicativo.

Características

• Belo DX : As coleções de conteúdo foram projetadas para fornecer uma experiência agradável do usuário. Oferece uma experiência perfeita do desenvolvedor sem a necessidade de reiniciar o servidor ou atualizar o navegador. As coleções de conteúdo são atualizadas automaticamente quando você faz alterações no seu conteúdo.

• Tipo Seguro : Seu conteúdo é analisado e validado durante o processo de construção, garantindo precisão e moeda. O Content Collections oferece uma API segura para acessar seu conteúdo.

• Simples de usar : Não há necessidade de buscar e analisar manualmente seu conteúdo. Basta importar e começar a usar coleções de conteúdo. Ele fornece uma API simples, permitindo que você se concentre na criação de seu aplicativo.

• Transformação : As coleções de conteúdo permitem transformar seu conteúdo antes de entrar no seu aplicativo. Você pode usá -lo para modificar seu conteúdo, participar de duas coleções ou até buscar dados de um servidor.

Instalação

A Content Collections oferece uma variedade de adaptadores que se integram perfeitamente às estruturas da web populares. O processo de instalação depende do adaptador escolhido:

• Next.js
• Qwik
• Remix (vite)
• Início sólido
• Sveltekit
• Vite

Se sua estrutura não estiver listada, você ainda poderá usar coleções de conteúdo usando a CLI. Por favor, abra um ingresso se quiser ver sua estrutura listada.

Uso

1. Crie um arquivo de conteúdo-colecionário.ts na raiz do seu projeto:

    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 ( ) ,
     } ) ,
   } ) ;
   
   export default defineConfig ( {
     collections : [ posts ] ,
   } ) ;

2. Comece a escrever conteúdo no src/posts :

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

3. Use seu conteúdo em seu aplicativo:

    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 >
     ) ;
   }

   Observe que o exemplo acima mostra apenas o básico das coleções de conteúdo e não cobre a transformação do conteúdo. As coleções de conteúdo não transformam conteúdo como Markdown ou MDX por padrão. Mas possui pacotes que podem fazer isso para você:

   • @Content-Collections/Markdown
   • @Content-Collections/MDX

   Se você deseja ver mais exemplos e usar casos, consulte a documentação.

Patrocinadores

Torne -se um patrocinador

Licença

As coleções de conteúdo são licenciadas sob a licença do MIT.