Docs

How to edit this site and how to build on the template: guides for editors and developers.

Get started

Introduction
What this template is, what the example site shows, and where to start reading.
How it works
The five ideas behind the template, explained without code.

Editor guide

Studio tour
Find your way around Sanity Studio: the menu, the tools and how publishing works.
Pages and blocks
Create a page, choose its address, and build it from blocks.
Blocks
Every block in the template, what it is for and the fields it has.
Collections and entries
Create a blog, a portfolio or any other section that repeats, and fill it with entries.
Images
Upload images, describe them for everyone, and choose what stays in view when they are cropped.
Site Settings
The name, menu, footer, search, languages and interface text of the whole site.
Translating content
Publish the site in more than one language, page by page.
Preview and publish
Check drafts on the real site with Presentation, click to edit, and publish when ready.
SEO and sharing
How pages appear in search results and when links are shared.

Developer guide

Installation
Set up the template locally, connect it to a Sanity project and add the example content.
Project structure
Where everything lives in the two apps.
Content model
The document types, how URLs map to them, and why entries are generic.
Adding a block
Turn any Nuxt UI component into a block editors can use, in five steps.
Queries and types
How GROQ queries are organized, typed with TypeGen and used in components.
Theming
Colors, fonts, component styles and the motion utilities of the Swiss theme.
Languages
How document translations, language prefixes, fallbacks and translated interface text work.
Visual Editing
Turn on the live preview in the Presentation tool, locally and in production.
Search
The search palette, its GROQ query and what it needs from the hosting.
SEO and social images
Meta tags, sitemap, robots, structured data and the generated social images.
Rendering and caching
Choose between server rendering, hybrid prerendering and a static site, and how pages are cached.
Deployment
Host the Studio on Sanity and the site on Vercel, Cloudflare or any Node server.
Writing these docs
How the guides are written in Markdown and imported into the Docs collection.