--- title: "Docs" description: "How to install and set up the Writing Room, a calm place to write long-form content in Sanity Studio." canonical_url: https://writingroom.studio/docs/ plugin_version: 0.3.0 license: MIT --- # Docs 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](https://github.com/mematthew123/sanity-plugin-writing-room/blob/main/CHANGELOG.md). What's next is in the [roadmap](https://github.com/mematthew123/sanity-plugin-writing-room/blob/main/ROADMAP.md). ## In these docs - [Requirements](https://writingroom.studio/docs/requirements.md): The plugin runs inside Sanity Studio. - [Install](https://writingroom.studio/docs/install.md): Three steps, from your Studio's folder. Covers: 1. Add the package; 2. Add the plugin, with the document types you write in; 3. Turn off Studio auto-updates; Which types?; Why auto-updates off? - [Look and feel](https://writingroom.studio/docs/look-and-feel.md): The room brings its own look, and none of it reaches the rest of your Studio. Covers: A matching Studio theme (optional). - [What the plugin adds](https://writingroom.studio/docs/what-the-plugin-adds.md) - [Document types](https://writingroom.studio/docs/document-types.md): The room writes Posts by default. Covers: Fields; Details; The body; Labels and URLs. - [Schema](https://writingroom.studio/docs/schema.md): You don't need the plugin's schema if you already have a type to write in: the room works with yours. - [Preview on your site](https://writingroom.studio/docs/preview-on-your-site.md): Preview opens the document on your site in draft mode, unpublished changes included. - [Troubleshooting](https://writingroom.studio/docs/troubleshooting.md): Covers: The Writing Room can't start in this Studio yet; Yarn, or two copies of the SDK; A type is missing from the Lobby. - [Compatibility](https://writingroom.studio/docs/compatibility.md): npm run smoke (in this package) packs the plugin, installs it with npm into a brand-new Studio and checks that. --- Writing Room is MIT licensed and free, made by [Zephyr Pixels](https://zephyrpixels.dev). Bugs and questions go to [GitHub issues](https://github.com/mematthew123/sanity-plugin-writing-room/issues). More: [About](https://writingroom.studio/about.md), [Contact](https://writingroom.studio/contact.md), [Privacy](https://writingroom.studio/privacy.md). Every page of this site as markdown: [https://writingroom.studio/llms.txt](https://writingroom.studio/llms.txt)