Getting Started

Sanity Structure Tool is a declarative, JSON based plugin for defining your Sanity Studio's desk structure. This guide provides a step-by-step roadmap to help you install the package and configure a maintainable content hierarchy.

Installation

Install the package using your preferred package manager.

npm

npm install sanity-plugin-structure-tool

yarn

yarn add sanity-plugin-structure-tool

pnpm

pnpm add sanity-plugin-structure-tool

bun

bun add sanity-plugin-structure-tool

Quick Roadmap

Once installed, follow these steps to get your studio up and running with a declarative structure:

1. Follow the Setup Guide: Learn how to configure the plugin and register it.
2. Define Your Items: Explore the ListItem configuration to build your hierarchy.
3. Browse Examples: See specific examples for properties like singleton, filter, and children.

Learn More

• Why this tool?: Understand the core philosophy and the problems it solves.
• FAQ: Find answers to common questions and troubleshooting tips.
• Contributing: Learn how to contribute to the project.

Need Help?

If you run into issues or have questions:

• Check the Issues on GitHub.
• Contributions are always welcome!