Keystatic & Astro
Этот содержимое пока не доступно на вашем языке.
Keystatic is an open source, headless content-management system that allows you to structure your content and sync it with GitHub.
PrerequisitesSection titled Prerequisites
- An existing Astro project with server-side rendering (SSR) and
Installing dependenciesSection titled 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.
You will also need two Keystatic packages:
Adding the Astro integrationSection titled Adding the Astro integration
Add the Astro integration from
@keystatic/astro in your Astro config file:
Creating a Keystatic config fileSection titled Creating a Keystatic config file
A Keystatic config file is required to define your content schema. This file will also allow you to connect a project to a specific GitHub repository (if you decide to do so).
Create a file called
keystatic.config.ts in the root of the project and add the following code to define both your storage type (
local) and a single content collection (
Keystatic is now configured to manage your content based on your schema.
Running Keystatic locallySection titled Running Keystatic locally
To launch your Keystatic Admin UI dashboard, start Astro’s dev server:
http://127.0.0.1:4321/keystatic in the browser to see the Keystatic Admin UI running.
Creating a new postSection titled Creating a new post
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
.mdocfile inside the
src/content/postsdirectory for this new post:
Navigate to that file in your code editor and verify that you can see the Markdown content you entered. For example:
Rendering Keystatic contentSection titled Rendering Keystatic content
Use Astro’s Content Collections API to query and display your posts and collections, just as you would in any Astro project.
Displaying a collection listSection titled Displaying a collection list
The following example displays a list of each post title, with a link to an individual post page.
Displaying a single entrySection titled 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:
For more information on querying, filtering, displaying your collections content and more, see the full content collections documentation.
Deploying Keystatic + AstroSection titled 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.