Sanity is a real-time content infrastructure. The editor, built in JavaScript and React.js, lives in this repo. It connects to a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches.
Table of contents
- Table of contents
- Getting started
- Key Features
- Plugins and tooling
- Useful links and resources
- Code of Conduct
- Want to contribute?
- License
Getting started
If you are running Node the commands below install the Sanity CLI tooling and boostraps a new project for you. Not running Node? Have a look at this.
npm install -g @sanity/cli
sanity init
Watch Getting started with Sanity on YouTube.
Check out the schema documentation and customize your data structure. When you're happy, just sanity deploy to host the editor with us and head over to sanity.io to invite editors.
As they're merrily content managing you can start setting up a front-end to render your data based on one of the demos we have available.
Feel totally free to ping us on Slack for a chat should you have questions along the way!
Key Features
Content Studio 🖋
- Efficient editing
- Open source, MIT license
- Real-time
- Plug-in architecture
- Block editor for structured content
Hosted Backend ☁️
- Secure, scalable and GDPR compliant
- Zero config Graph Oriented Query Language (GROQ)
- Hard references for integrity
- API & asset CDNs
- Capable image pipeline
Plugins and tooling
Content Studio plugins
Check out our plugin page
Input types
- Google Maps (
sanity install @sanity/google-maps-input) - Color (
sanity install @sanity/color-input) - Code (syntax highlighted blocks) (
sanity install @sanity/code-input) - Data table (
sanity install datatable) - LaText (
sanity install latex-input) - Mux Video (
sanity install mux-input) - Markdown (
sanity install markdown) - Table (
sanity install table) – URL Metadata (sanity install url-metadata-input)
Tools
- Vision - GROQ sandbox tool (
sanity install @sanity/vision)
Schema plugins
- Podcast schema (
sanity install podcast)
Migration tools
- Tools for processing Portable Text (
npm i @sanity/block-tools) - Convert Portable Text into a generic tree (
npm i @sanity/block-content-to-tree) - Migrate from Contentful to Sanity (
npm install -g contentful-to-sanity) - Migrate from podcast RSS feed to Sanity (
npm install -g podcast-to-sanity)
API Clients
Sample frontends
- Next.js: Movie Studio | Blog
- Gatsby.js: Company Website
- React Native: Movie Studio
- Vue.js: Movie Studio | Ecommerce
- Silex + Twig: Movie Studio
Frontend rendering
- Block content to HTML (
npm i @sanity/block-content-to-html) - Block content to Hyperscript (
npm i @sanity/block-content-to-hyperscript) - Block content to Markdown (
npm i @sanity/block-content-to-markdown) - Block content to React (
npm i @sanity/block-content-to-react) - Block content to Vue (Thanks @rdunk!)
- Quickly generate image urls from Sanity image records (
npm i @sanity/image-url)
Community contributed plugins
We are grateful for all who dedicate their time making stuff for the Sanity.io community ❤️. These are to the best of our knowledge ready for use. If you encounter any problems with these packages, please file an issue in their respective GitHub repositories, and remember to be nice and constructive.
- C# /.NET client (Thanks @onybo!)
- .NET client (Thanks @oslofjord!)
- Laravel (PHP) client (Thanks @eastslopestudio!)
- Sanity Query Helper (Thanks @staccx!)
Useful links and resources
Stay up to date
- Follow @sanity_io on twitter – Subscribe to our blog by RSS
- Subscribe to our newsletter
Documentation
The documentation covers how to work with content in Sanity, schema types, extending the content studio, how to query the API, importing data and useful tips for presenting your content in a frontend.
Blogs, tutorials and other reads
- The Sanity.io blog – Tutorial: How to quickly set up a Gatsby.js JAMstack website with a headless CMS
- Tutorial: A Sanity backed blog with React and Next.js
- Headless in Love with Sanity
- Sanity with serverless Webtask and Google's Dialogflow
- Design with real content: How to connect Sanity with Sketch using Craft’s InVision plugin
- Five interesting ways to use Sanity.io for image art direction
- Build an Angular E-Commerce App on Top of Sanity's Headless CMS
Code of Conduct
We aim to be an inclusive, welcoming community for everyone. To make that explicit, we have a code of conduct that applies to communication around the project.
Want to contribute?
Found a bug, or want to contribute code? Pull requests and issues are most welcome. You might want to take a look at our Contributing guidelines also.
License
The Sanity Content Studio is available under the MIT License
