Caisy Developer Documentation

Next.js is a React framework that simplifies server-rendered React applications, which is particularly useful for Jamstack websites. Next.js can create both static and server-rendered pages, resulting in high-performance pages with fast load times. It offers built-in features like automatic code splitting and search engine optimization capabilities, leading to improved performance and simpler development compared to Create React App.

The Rich text renderer is a library for rendering rich text content from the caisy CMS. It uses a JSON-based structure that allows rendering the same content across different platforms (Web, Android, iOS) and supports embedding custom components within rich text.

The caisy developer documentation covers framework integrations (Next.js, Svelte, Vue/Nuxt, Astro) and core topics including Queries, Pagination, Filter and Order, Authentication, External GraphQL API, Internal API, Webhooks, Rich Text rendering, and Live Preview. Start with the Quickstart guide to set up your first project.

The caisy developer quickstart covers three core operations: (1) Create a Blueprint to define your content structure, (2) Publish content via the API, and (3) Query content using GraphQL. This workflow enables developers to build applications on caisy's headless CMS platform.

caisy provides integration examples for multiple frontend frameworks. Each example demonstrates best practices for connecting to the caisy API, querying content, and rendering dynamic pages. Available framework examples: Next.js, SvelteKit, Nuxt (Vue.js), Astro, and Qwik.

The Asset API handles uploading and serving media assets. The Asset CDN enables on-the-fly image resizing and delivers images in the best supported format for each client.

Caisy provides three API categories: Internal API (platform operations), External API (public integrations), and Asset API (media handling). All APIs support GraphQL queries and SDK integration.

Live Preview works through three key components: (1) Live Updates - establishes a continuous event stream between collaborators using Caisy and your frontend, instantly updating preview on every change; (2) Editable Content Highlighting - intelligently highlights editable content regions on the page, clicking any highlighted area navigates directly to the corresponding section in Caisy; (3) Connection Status - a dedicated indicator shows when editors are successfully connected to the live preview experience.

Live Preview works through three key components: (1) Live Updates - a continuous WebSocket event stream between all collaborators and your frontend application, instantly syncing every change; (2) Editable Content Highlighting - the preview highlights editable regions on your page, and clicking a highlighted area navigates directly to the corresponding field in the Caisy interface; (3) Connection Status - a dedicated indicator shows when editors are successfully connected to the live preview experience.

Live Preview enables real-time content editing in caisy by displaying changes instantly in your frontend without page reloads. Content creators and developers can see how changes will appear on the live website before publishing. The feature connects your frontend directly with the Caisy interface through continuous event streams, ensuring every keystroke and click instantly updates the preview.