How SanityPress Works

The Schema¶

Documents¶

📁 /src/sanity/schemaTypes/documents

High-level standalone data types, typically found in the sidebar of the Sanity Studio.

Read more in the blog post here. 🛣️

Site settings¶

• Site — a singleton data type used for global data such as logo(s) and copyright info, etc.

Pages (routes)¶

• Page — a Next.js route with a unique slug (permalink) composed of modules (/*).
• Global module — add common modules for the defined path; e.g. * (all pages) and blog/.

Blog¶

• Blog post — like page documents but solely for blog content that resides under the blog/ URL path.
• Blog category — useful for filtering blog posts.

Menus & redirects¶

• Navigation — a collection of links (header/footers menus and social links, etc).
• Redirect — URL rewrites.

Miscellaneous¶

A collection of reusable content that can be referenced within other documents and modules, such as:

• Announcement — schedule-able hotline banners displayed above the site header. Make sure to register them in the site document.
• Logos — used in the Logo list module, etc.
• Person — used as blog authors, as employee lists, etc.
• Pricing tiers — used in the Pricing list module.
• Reputation — set a GitHub repo to automatically retrieve the star and fork counts.
• Testimonials — used in the Testimonial-list and Testimonial (featured) modules.

Objects¶

📁 /src/sanity/schemaTypes/objects

A collection of primitive fields, typically found to compose modules or documents.

• CTA — call-to-action; a wrapper around the link object with additional.
• Link — a collection of fields used to reference internal pages or link to external URLs.
• Link list — an array of links, used in navigation documents.
• Metadata — a collection of fields used for SEO purposes (title, description, slug, no-indexing, etc).
• Module options — helpful fields that can be assigned per module; include a hidden field (module visibility) and a uid field (used for jump links and selectors for custom CSS).

Modules¶

📁 /src/sanity/schemaTypes/modules

Document schema types are composed of Next.js components called modules (a.k.a. "sections" or "building blocks") that can be re-used and re-ordered. Modules are meant to be added and customized to suit your needs.

Each module has a Next.js component file(s) and a corresponding Sanity schema file.

Find a list of all built-in modules (with live examples) here. 🧱

Learn how to schedule content with the Schedule module.

The Studio¶

yourwebsite.com/admin (replace with your domain)

Hitting "publish" on any document in the Studio will instantly update on your live site. Read more about the Sanity's Live Content API in this blog post.

Screenshots of the Sanity Studio can be found here. 🖼️