--- title: SolidStart description: Use Content Collections with SolidStart linkText: Quickstart SolidStart icon: solid category: frameworks ---
Install required packages: We have to install the following packages: - `@content-collections/core` - `@content-collections/vinxi` - `zod` ```package-install npm i @content-collections/core @content-collections/vinxi zod -D ```
Adjust your `tsconfig.json`: ```json { "compilerOptions": { // ... "paths": { "~/*": ["./src/*"], "content-collections": ["./.content-collections/generated"] } } } ``` We require a path alias for the generated files. This is necessary because we will generate the files in the `.content-collections/generated` folder.
Modify your `app.config.ts`: ```ts import { defineConfig } from "@solidjs/start/config"; import contentCollections from "@content-collections/vinxi"; export default defineConfig({ vite: { plugins: [contentCollections()], }, }); ``` Add the Content Collections plugin to your Vinxi config. For more details on the Vinxi adapter, refer to the [documentation](/docs/adapter/vinxi).
Add the new `.content-collections` directory to your project's `.gitignore` file — the files in this directory are always regenerated and can be safely ignored by Git. ``` .content-collections ```
Create a `content-collections.ts` file at the root of your project: ```ts import { defineCollection, defineConfig } from "@content-collections/core"; import { z } from "zod"; const posts = defineCollection({ name: "posts", directory: "src/posts", include: "**/*.md", schema: z.object({ title: z.string(), summary: z.string(), content: z.string(), }), }); export default defineConfig({ content: [posts], }); ``` This file defines a collection named `posts` in the `src/posts` folder. The collection will include all markdown files (`**/*.md`) and the schema will validate the `title` and `summary` fields. For more information about the configuration have a look at the [documentation](/docs/configuration).
Create your content files (e.g.: `src/posts/hello-world.md`): ```md --- title: "Hello world" summary: "This is my first post!" --- # Hello world This is my first post! ... rest of the content ``` You can create unlimited content files. These files will be validated against the schema defined in the `content-collections.ts` file. If the files are valid, they will be automatically added to the `posts` collection.
Usage in your code: ```tsx import { allPosts } from "content-collections"; export function Posts() { return ( ); } ``` Now you can just import the `allPosts` collection and use it in your code. The `allPosts` collection will contain all posts that are valid. The `post` object will contain the `title`, `summary` and `content` fields as well as some meta information in the `_meta` field.