The Sanity Content Studio – Collaborate in real-time on structured content
Switch branches/tags
Clone or download

README.md

Sanity Logo

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

Content Studio, Backend and Content Interfaces

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

Then 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 or Gitter 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

Input types

Tools

Schema plugins

Migration tools

API Clients

Sample frontends

Frontend rendering

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.

Useful links and resources

Stay up to date 🗞

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

Content spread throughout the urban scape

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