Skip to content
Writing Room

Docs

View as Markdown

A calm, full-screen place to write long-form content inside Sanity Studio: Posts, articles, case studies, whatever your Studio writes.

Most Studios put writing in a form: panes, field labels and a toolbar around every sentence. The Writing Room is a Studio Tool with its own route that shows only a document’s title and body, and gets out of the way while you type. Everything else (slug, excerpt, cover image, tags, any field of your own) is under Details: one click swaps the body for those fields, without leaving the room. It works with the document types you already have.

  • The Lobby: a doorway, not a document browser. Continue the piece you were last in, start something new, or pick from a few recent ones. The Studio’s navbar stays above it, and Structure is one link away for everything else.
  • Controls that recede: Leave on one side; status, Details, Preview and Publish on the other. They fade after a few keystrokes and return when you pause. The word count sits at the foot of the page, and anything the room needs to tell you appears there too.
  • Formatting on selection: bold, italic, headings, quotes and links in a small bubble above selected text.
  • An insert menu: click the + beside an empty line, or type /, for images, embeds (YouTube, Vimeo, Spotify), code blocks, section breaks, quotes and lists.
  • Markdown as you type: ##, >, -, 1., --- and code fences.
  • Room settings: one Aa menu for text size, typewriter scrolling and focus dimming (kept per Writer in the browser, no setup), dark mode and fullscreen.
  • Any screen: on a phone or a narrow window the controls keep to Leave, Aa and Publish, and the rest moves into the Aa menu.
  • Live sync and presence through the Sanity App SDK. The room says when you’re offline and keeps your words until you’re back.
  • Publish from the room: the slug is settled and the date stamped for you. If something blocks the publish, the room takes you straight to it; if nothing does, it shows where the document will go live and asks once. Afterwards, a link to the live page (when preview says where your site is).
  • Preview opens the document on your site in draft mode, exactly as readers will see it.

Status: 0.x. The API may change before 1.0; breaking changes are listed in the changelog. What’s next is in the roadmap.