sanity
Assists with building content platforms using Sanity's structured content and real-time collaboration features. Use when defining schemas, writing GROQ queries, configuring Sanity Studio, or integrating with Next.js for content-driven sites. Trigger words: sanity, groq, sanity studio, structured content, portable text, content lake, sanity schema.
Usage
Getting Started
- Install the skill using the command above
- Open your AI coding agent (Claude Code, Codex, Gemini CLI, or Cursor)
- Reference the skill in your prompt
- The AI will use the skill's capabilities automatically
Example Prompts
- "Write a blog post about the benefits of AI-assisted development"
- "Create social media copy for the product launch announcement"
Documentation
Overview
Sanity is a structured content platform with real-time collaboration, GROQ querying, and a customizable React-based Studio. Content is stored in the Content Lake with CDN delivery, Portable Text for structured rich content, and visual editing capabilities for live frontend previews.
Instructions
- When defining schemas, use
defineType()anddefineField()with validation rules, model content for reuse by separating pages from content blocks, and use references over inline objects for shared content. - When querying data, write GROQ queries with projections to fetch only needed fields, use the
->dereference operator for joined data, and setuseCdn: truefor production reads. - When customizing Sanity Studio, configure desk structure for sidebar navigation, add custom input components for specialized editing, and create custom publish workflows with actions.
- When building rich content, use Portable Text which is structured data (not HTML) that renders on any platform, with customizable toolbar, custom blocks, and inline objects.
- When integrating with Next.js, use
next-sanitywith ISR, preview mode, and visual editing, and@sanity/visual-editingfor click-to-edit overlays in the frontend. - When managing environments, use datasets (production, staging, development) for content isolation, GROQ-powered webhooks for filtered build triggers, and set
apiVersionto a specific date to avoid breaking changes. - When handling images, use Sanity's image with hotspot for focal point selection and
sanity-image-urlfor generating responsive image URLs with transforms.
Examples
Example 1: Build a content-driven marketing site
User request: "Set up Sanity with Next.js for a marketing site with modular page builder"
Actions:
- Define page, hero, feature, CTA, and testimonial schemas as reusable block types
- Configure Sanity Studio with desk structure and live preview
- Set up
next-sanitywith ISR and GROQ queries for each page type - Enable visual editing with
@sanity/visual-editingfor click-to-edit overlays
Output: A modular marketing site where editors build pages from reusable content blocks with live preview.
Example 2: Implement real-time content preview
User request: "Add live preview to our Sanity + Next.js site so editors see changes as they type"
Actions:
- Configure Sanity Studio's Presentation tool for side-by-side editing
- Set up
@sanity/visual-editingin the Next.js frontend for click-to-edit overlays - Use
client.listen()for real-time content updates in preview mode - Configure draft content display with
!(_id in path("drafts.**"))filtering
Output: A live editing experience where content changes appear in the frontend as editors type.
Guidelines
- Use
defineType()anddefineField()for schema definitions; they provide TypeScript types for the Studio. - Model content for reuse: separate pages from content blocks so blocks can appear on any page.
- Use references over inline objects for content that appears in multiple places.
- Query with GROQ projections to fetch only needed fields, not entire documents.
- Use the CDN API (
useCdn: true) for production reads; it is free and fast. - Set
apiVersionto a specific date to avoid breaking changes. - Use Portable Text for rich content; it is structured data that renders on any platform.
Information
- Version
- 1.0.0
- Author
- terminal-skills
- Category
- Content
- License
- Apache-2.0