ButterflyPress Documentation
Learn how ButterflyPress decouples Wagtail CMS data modeling from multi-framework UI templates via OpenAPI camelCase contracts and Shadcn custom registries.
Quickstart in 3 Steps
Install @butterflypress/core alongside your framework adapter (astro,
react, nextjs, or vue), then initialize the ButterflyPress Shadcn registry
in your project.
1. Install Core + Framework SDK bash
# Astro
pnpm add @butterflypress/core @butterflypress/astro
# React / Next.js
pnpm add @butterflypress/core @butterflypress/react @butterflypress/nextjs
# Vue 3 / Nuxt
pnpm add @butterflypress/core @butterflypress/vue 2. Initialize Shadcn Registry & Add Blocks bash
npx @butterflypress/cli init
npx @butterflypress/cli add section split grid card hero 3. Fetch & Render Normalized StreamFields ts
import { createButterflyPressClient } from "@butterflypress/core"
const client = createButterflyPressClient({ apiBaseUrl: import.meta.env.CMS_URL })
const page = await client.getPageByPath("/") 3-Layer Architecture
Intention containers, composable atoms, and semantic fallback engine.
Shadcn Design Tokens
Dual Light/Dark CSS variables and the 7 built-in generic theme archetypes.
Block Catalog Reference
Canonical camelCase JSON, TypeScript interfaces, Cotton tags, and live previews.
Multi-Theme Showcase
Test Astro, React, and Vue side-by-side across all 7 archetypes.