--- title: "Docs · Sanity × Nuxt UI" description: "How to edit this site and how to build on the template: guides for editors and developers." canonical_url: "https://sanity-nuxtui.vercel.app/docs" meta: "og:description": "How to edit this site and how to build on the template: guides for editors and developers." "og:image": "https://sanity-nuxtui.vercel.app/_og/d/c_Page%2Ctitle_Docs%2Cdescription_~SG93IHRvIGVkaXQgdGhpcyBzaXRlIGFuZCBob3cgdG8gYnVpbGQgb24gdGhlIHRlbXBsYXRlOiBndWlkZXMgZm9yIGVkaXRvcnMgYW5kIGRldmVsb3BlcnMu%2CsiteName_~U2FuaXR5IMOXIE51eHQgVUk%2Cp_Ii9kb2NzIg%2Cs_TnntuXJ0w4Evyte_.png" "og:image:height": "630" "og:image:type": image/png "og:image:width": "1200" "og:title": "Docs · Sanity × Nuxt UI" "twitter:image": "https://sanity-nuxtui.vercel.app/_og/d/c_Page%2Ctitle_Docs%2Cdescription_~SG93IHRvIGVkaXQgdGhpcyBzaXRlIGFuZCBob3cgdG8gYnVpbGQgb24gdGhlIHRlbXBsYXRlOiBndWlkZXMgZm9yIGVkaXRvcnMgYW5kIGRldmVsb3BlcnMu%2CsiteName_~U2FuaXR5IMOXIE51eHQgVUk%2Cp_Ii9kb2NzIg%2Cs_TnntuXJ0w4Evyte_.png" --- > Index of every page on this site: [llms.txt](https://sanity-nuxtui.vercel.app/llms.txt) # **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. [Introduction](https://sanity-nuxtui.vercel.app/docs/introduction) How it works The five ideas behind the template, explained without code. [How it works](https://sanity-nuxtui.vercel.app/docs/how-it-works) ## **Editor guide** Studio tour Find your way around Sanity Studio: the menu, the tools and how publishing works. [Studio tour](https://sanity-nuxtui.vercel.app/docs/studio-tour) Pages and blocks Create a page, choose its address, and build it from blocks. [Pages and blocks](https://sanity-nuxtui.vercel.app/docs/pages-and-blocks) Blocks Every block in the template, what it is for and the fields it has. [Blocks](https://sanity-nuxtui.vercel.app/docs/blocks) Collections and entries Create a blog, a portfolio or any other section that repeats, and fill it with entries. [Collections and entries](https://sanity-nuxtui.vercel.app/docs/collections) Images Upload images, describe them for everyone, and choose what stays in view when they are cropped. [Images](https://sanity-nuxtui.vercel.app/docs/images) Site Settings The name, menu, footer, search, languages and interface text of the whole site. [Site Settings](https://sanity-nuxtui.vercel.app/docs/site-settings) Translating content Publish the site in more than one language, page by page. [Translating content](https://sanity-nuxtui.vercel.app/docs/translating-content) Preview and publish Check drafts on the real site with Presentation, click to edit, and publish when ready. [Preview and publish](https://sanity-nuxtui.vercel.app/docs/preview-and-publish) SEO and sharing How pages appear in search results and when links are shared. [SEO and sharing](https://sanity-nuxtui.vercel.app/docs/seo) ## **Developer guide** Installation Set up the template locally, connect it to a Sanity project and add the example content. [Installation](https://sanity-nuxtui.vercel.app/docs/installation) Project structure Where everything lives in the two apps. [Project structure](https://sanity-nuxtui.vercel.app/docs/project-structure) Content model The document types, how URLs map to them, and why entries are generic. [Content model](https://sanity-nuxtui.vercel.app/docs/content-model) Adding a block Turn any Nuxt UI component into a block editors can use, in five steps. [Adding a block](https://sanity-nuxtui.vercel.app/docs/adding-a-block) Queries and types How GROQ queries are organized, typed with TypeGen and used in components. [Queries and types](https://sanity-nuxtui.vercel.app/docs/queries-and-types) Theming Colors, fonts, component styles and the motion utilities of the Swiss theme. [Theming](https://sanity-nuxtui.vercel.app/docs/theming) Languages How document translations, language prefixes, fallbacks and translated interface text work. [Languages](https://sanity-nuxtui.vercel.app/docs/languages) Visual Editing Turn on the live preview in the Presentation tool, locally and in production. [Visual Editing](https://sanity-nuxtui.vercel.app/docs/visual-editing) Search The search palette, its GROQ query and what it needs from the hosting. [Search](https://sanity-nuxtui.vercel.app/docs/search) SEO and social images Meta tags, sitemap, robots, structured data and the generated social images. [SEO and social images](https://sanity-nuxtui.vercel.app/docs/seo-and-social-images) Rendering and caching Choose between server rendering, hybrid prerendering and a static site, and how pages are cached. [Rendering and caching](https://sanity-nuxtui.vercel.app/docs/rendering-and-caching) Deployment Host the Studio on Sanity and the site on Vercel, Cloudflare or any Node server. [Deployment](https://sanity-nuxtui.vercel.app/docs/deployment) Writing these docs How the guides are written in Markdown and imported into the Docs collection. [Writing these docs](https://sanity-nuxtui.vercel.app/docs/writing-docs) ```json {"@context":"https://schema.org","@graph":[{"@id":"https://sanity-nuxtui.vercel.app/#website","@type":"WebSite","name":"Sanity × Nuxt UI","url":"https://sanity-nuxtui.vercel.app/","publisher":{"@id":"https://sanity-nuxtui.vercel.app/#identity"}},{"@id":"https://sanity-nuxtui.vercel.app/docs#webpage","@type":"WebPage","description":"How to edit this site and how to build on the template: guides for editors and developers.","name":"Docs","url":"https://sanity-nuxtui.vercel.app/docs","isPartOf":{"@id":"https://sanity-nuxtui.vercel.app/#website"},"potentialAction":[{"@type":"ReadAction","target":["https://sanity-nuxtui.vercel.app/docs"]}]},{"@id":"https://sanity-nuxtui.vercel.app/#identity","@type":"Organization","name":"Sanity × Nuxt UI","url":"https://sanity-nuxtui.vercel.app"}]} ``` ## Sitemap See the full [sitemap](https://sanity-nuxtui.vercel.app/sitemap.md) for all pages.