sanity-plugin-workspace-home

This is a Sanity Studio v3 plugin.

This plugin adds a "Home" Tool to your Studio with a listing of all available workspaces. Useful as the first page of your Studio to quickly navigate to the workspace of your choice.

Installation

npm install sanity-plugin-workspace-home

Usage

For simple installation, import the predefined workspace config from the plugin and use it as the first config in your sanity.config.ts (or .js) file.

import {defineConfig} from 'sanity'
import {workspaceHomeConfig} from 'sanity-plugin-workspace-home'

export default defineConfig([
  workspaceHomeConfig({
    // projectId and dataset are required, but not used by the plugin
    projectId: 'replace-with-your-project-id',
    dataset: 'replace-with-your-dataset-name',    
  }),
  // ...all other workspaces
])

Alternatively, define your own workspace config for the plugin. This plugin is designed to be used in a workspace where it is the only plugin. This should be the first workspace configured in sanity.config.ts (or .js).

import {defineConfig} from 'sanity'
import {workspaceHome} from 'sanity-plugin-workspace-home'

export default defineConfig([{
  {
    name: 'home',
    title: 'Home',
    basePath: '/home',
    icon: HomeIcon,
    plugins: [workspaceHome()],
    // projectId and dataset are required, but not used by the plugin
    projectId: 'replace-with-your-project-id',
    dataset: 'replace-with-your-dataset-name',
  },
  // ...all other workspaces
}])

License

MIT © Sanity

Develop & test

This plugin uses @sanity/plugin-kit with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio on how to run this plugin with hotreload in the studio.

Release new version

Run "CI & Release" workflow. Make sure to select the main branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.