Keystatic is a Content Management for your Codebase. Its primary function is to make Markdown, JSON, and YAML content within your codebase editable by humans. It is designed to allow users to live edit content on GitHub or your local file system without interfering with existing code and workflows.

Features:

Architecture and Core Experience

• First-class CMS Experience: Keystatic aims to provide a high-quality content management experience.

• Database-less: A fundamental feature is that it uses no database. Content is based on Markdown, YAML, and JSON files.

• Editing Modes: It supports two-way editing. Content can be edited via the Admin UI or directly in codebase files.

• Language Support: It features a TypeScript API.

• Content Format Support: It supports Markdoc and MDX.

Integration and Setup

• Framework Integration: Keystatic offers official integration guides for major frameworks, including Astro, Next.js, and Remix.

• Quick Start: Developers can set up a new Next.js, Astro, or Remix project quickly using the Keystatic CLI (npm create @keystatic@latest).

• GitHub Connectivity (GitHub Mode): It supports connecting to GitHub to manage content. The core concepts include Local mode and GitHub mode.

• Keystatic Cloud: Keystatic Cloud offers services like simplifying GitHub authentication and providing tools to optimise images.

Content Management and Structuring

• Content Organization: Keystatic needs to be taught how to find and organize content within the codebase.

• Content Structures: Content organization is set up using Collections (for multiple entries) and Singletons (for unique settings/pages).

• Fields API: It offers a comprehensive Fields API for defining content schemas, including:

  • Basic types: Text, Number, Integer, URL, Checkbox, Date, Datetime, and Select.

  • Media/Files: Image, File, and Cloud Image.

  • Complex structures: Array, Blocks, Object, Relationship, Conditional, Markdoc, and MDX.

• Core Concepts: Functionalities rely on core concepts such as Content organisation, Path wildcard, Format options, and Entry Layout.

Data Retrieval (Reader API)

• Reader API: Developers can retrieve data from the project directory using the Reader API. This API allows querying content, such as listing slugs from a collection.