About

Imported from terminalskills/skills (skills/sanity/SKILL.md). Install upstream with npx skills add terminalskills/skills --skill sanity. Copyright stays with the author (Apache-2.0).

Sanity

Name: sanity
Author: terminalskills

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() and defineField() 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 set useCdn: true for 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-sanity with ISR, preview mode, and visual editing, and @sanity/visual-editing for 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 apiVersion to a specific date to avoid breaking changes.
When handling images, use Sanity's image with hotspot for focal point selection and sanity-image-url for 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-sanity with ISR and GROQ queries for each page type
Enable visual editing with @sanity/visual-editing for 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-editing in 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() and defineField() 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 apiVersion to a specific date to avoid breaking changes.
Use Portable Text for rich content; it is structured data that renders on any platform.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/terminalskills-skills-sanity/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

terminalskills-skills-sanity.ocm.jsonjson

{
  "ocm": "1",
  "id": "terminalskills-skills-sanity",
  "kind": "skill",
  "name": "sanity",
  "description": "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.",
  "publisher": "terminalskills",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "sanity",
      "cms",
      "structured-content",
      "groq",
      "headless-cms",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "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."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/terminalskills/skills",
      "path": "skills/sanity/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/terminalskills/skills/blob/HEAD/skills/sanity/SKILL.md",
      "key": "terminalskills/skills/skills/sanity/SKILL.md"
    },
    "compatibility": "Sanity Studio requires Node.js 18+; Content Lake is fully managed",
    "license": "Apache-2.0"
  },
  "instructions": "# Sanity\n\n## Overview\n\nSanity 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.\n\n## Instructions\n\n- When defining schemas, use `defineType()` and `defineField()` with validation rules, model content for reuse by separating pages from content blocks, and use references over inline objects for shared content.\n- When querying data, write GROQ queries with projections to fet",
  "cost": {
    "context_tokens": 852
  }
}

Fetch it by URL: GET /api/v1/registry/terminalskills-skills-sanity/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.