Browse documentation

Keystatic article publishing

Connect a GitHub-backed collection, release reviewed articles and deploy them using your own build process.

On this page

Connect the right collection

Keystatic publishing is available on Starter, Growth and Pro. In PB, choose your website, open Publishing and select Keystatic.

This connection supports GitHub-backed collections with inline frontmatter and ordinary Markdown/Markdoc content in one .mdoc, .mdx or configured .md file. Your collection must use format: { contentField: 'content' }, replacing content with the actual content field name. Split metadata/body files, media uploads, custom Markdoc components and executable MDX are outside this version.

Configure repository access and field mapping

Create a dedicated fine-grained GitHub token restricted to the repository, with Contents and Pull requests read/write access. Keep it in PB's connection settings.

Enter owner/repository, the publication branch and a file path such as content/posts/{slug}.mdoc or content/posts/{slug}/index.mdoc. Map the title field and optional date/excerpt fields. Supply other required fields as JSON, for example {"author":"Garden team","tags":["gardening"]}.

Save and check the connection. This verifies repository and branch access. Review the first generated file against your Keystatic schema; a successful connection check does not validate every field or prove that the website will build.

Review and release an article

Open the finished article in PB and approve its exact version. Send for Git review creates a content pull request; subsequent edits update the same branch. Review that pull request before choosing Release to Git and confirming the release.

GitHub branch protection and required checks still apply. Existing files at the target path and external article-branch edits are not overwritten. After a merge, make further edits in your repository in this version.

The mapped date uses article creation time, or its scheduled publication time, in UTC. A confirmed publication schedule can run the approved Git release at the chosen time. An editorial calendar date alone does not release content.

Use Agent with Keystatic

In Agent → Publishing Autopilot, use Drafts only or Publish after review. For reviewed delivery, choose Send for Git review or Release to Git after review. Keystatic does not support Automatic publishing without article-by-article approval.

Choose and review the shared monthly article limit before enabling the permission. Publishing Autopilot explains its limits, expiry and pause controls. Approving a background workflow does not replace the exact-version article review required for Git delivery.

Check your hosting deployment

PB reports Released to Git when GitHub confirms the merge into your publication branch. That makes the article file available in the repository; it does not build your website or upload a deployment.

If your host or GitHub Actions already builds from this branch, follow that build and deployment. Check its result and open the final public article URL.

If you build locally on a laptop, pull the merged changes, run your project's normal build and deploy the output using your existing hosting process. You do not have to build on the VPS. Until that deployment finishes, the article can be released in Git while the public site still shows the previous build.

Troubleshoot the first release

If a pull request exists but is not merged, inspect required checks and branch protection. If the merge succeeded but the article is absent, check the publication branch, collection path, required fields and build/deployment output. Confirm that your site's article listing includes the new content.

If Agent holds delivery, check the finished article's approval, connection and publishing permission. Include the failed step and error message when contacting support@prerenderbuddy.com; never send the token.

Disconnecting removes PB's stored GitHub access. It does not delete repository files or pull requests. Revoke the token in GitHub separately when needed.

Instructions for your connected site

Open account setup for domain-specific values, diagnostics and copy-ready configuration. These stay private to your workspace.