Keystatic & Astro

Keystatic is an open source, headless content-management system that allows you to structure your content and sync it with GitHub.

:::tip If you're starting a new Astro + Keystatic project from scratch, you can use the Keystatic CLI to generate a new project in seconds:

```shell npm create @keystatic@latest ``` ```shell pnpm create @keystatic@latest ``` ```shell yarn create @keystatic ```

Select the Astro template, and you'll be ready to deploy! :::

Prerequisites

An existing Astro project with an adapter configured.

:::note If you intend to sync Keystatic's data with GitHub, you will also need a GitHub account with write permissions on the repository for this project. :::

Installing dependencies

Add both the Markdoc (for content entries) and the React (for the Keystatic Admin UI Dashboard) integrations to your Astro project, using the astro add command for your package manager.

```shell npx astro add react markdoc ``` ```shell pnpm astro add react markdoc ``` ```shell yarn astro add react markdoc ```

You will also need two Keystatic packages:

```shell npm install @keystatic/core @keystatic/astro ``` ```shell pnpm add @keystatic/core @keystatic/astro ``` ```shell yarn add @keystatic/core @keystatic/astro ```

Adding the Astro integration

Add the Astro integration from @keystatic/astro in your Astro config file:

// astro.config.mjs

:::note[Already using content collections?] If you are already using content collections in your Astro project, then update the schema above to exactly match the collection(s) defined in your existing schema. :::

Keystatic is now configured to manage your content based on your schema.

Running Keystatic locally

To launch your Keystatic Admin UI dashboard, start Astro's dev server:

```bash
npm run dev
```

Visit http://127.0.0.1:4321/keystatic in the browser to see the Keystatic Admin UI running.

Creating a new post

1. In the Keystatic Admin UI dashboard, click on the “Posts” collection.

Use the button to create a new post. Add the title "My First Post" and some content, then save the post.
This post should now be visible from your "Posts" collection. You can view and edit your individual posts from this dashboard page.
Return to view your Astro project files. You will now find a new .mdoc file inside the src/content/posts directory for this new post:
- src/ - content/ - posts/ - **my-first-post.mdoc**
Navigate to that file in your code editor and verify that you can see the Markdown content you entered. For example:
```
---
title: My First Post
---

This is my very first post. I am **super** excited!
```

Rendering Keystatic content

Query and display your posts and collections, just as you would in any Astro project.

Displaying a collection list

The following example displays a list of each post title, with a link to an individual post page.

---
import { getCollection } from 'astro:content'

const posts = await getCollection('posts')
---
<ul>
  {posts.map(post => (
    <li>
      <a href={`/posts/${post.id}`}>{post.data.title}</a>
    </li>
  ))}
</ul>

Displaying a single entry

To display content from an individual post, you can import and use the <Content /> component to render your content to HTML:

---
import { getEntry } from 'astro:content'

const post = await getEntry('posts', 'my-first-post')
const { Content } = await post.render()
---

<main>
  <h1>{post.data.title}</h1>
  <Content />
</main>

For more information on querying, filtering, displaying your collections content and more, see the full content collections documentation.

Deploying Keystatic + Astro

To deploy your website, visit our deployment guides and follow the instructions for your preferred hosting provider.

You'll also probably want to connect Keystatic to GitHub so you can manage content on the deployed instance of the project.

Official Resources

Check out the official Keystatic guide
Keystatic starter template