Skip to content
Writing Room

Install

View as Markdown

Three steps, from your Studio’s folder.

1. Add the package.

npm install sanity-plugin-writing-room

2. Add the plugin, with the document types you write in.

// sanity.config.ts
import {writingRoom} from 'sanity-plugin-writing-room'

export default defineConfig({
  // …
  plugins: [structureTool(), writingRoom({types: ['post']})],
})

3. Turn off Studio auto-updates.

// sanity.cli.ts
export default defineCliConfig({
  // …
  deployment: {autoUpdates: false},
})

That’s all. Run sanity dev: Writing Room appears in the Studio’s navigation, and each of those documents gets an Open in Writing Room action.

Which types? Your own post, article, caseStudy… The room finds each one’s title, body, slug and published date by itself (see Document types) and only offers what its body can store. No Post type yet? Register the starter one: schema: {types: writingRoomSchemaTypes} (see Schema).

Why auto-updates off? The room uses Sanity’s App SDK (@sanity/sdk-react). An auto-updating Studio loads sanity from a CDN but bundles its own copy of the SDK, so the two never share a React context and the room can’t start. This only shows up in a deployed Studio, not in sanity dev. To upgrade later, bump sanity and deploy again.