--- title: "Writing these docs · Sanity × Nuxt UI" description: "How the guides are written in Markdown and imported into the Docs collection." canonical_url: "https://sanity-nuxtui.vercel.app/docs/writing-docs" meta: "og:description": "How the guides are written in Markdown and imported into the Docs collection." "og:image": "https://sanity-nuxtui.vercel.app/_og/d/c_Page%2Ctitle_Writing%2Bthese%2Bdocs%2Cdescription_How%2Bthe%2Bguides%2Bare%2Bwritten%2Bin%2BMarkdown%2Band%2Bimported%2Binto%2Bthe%2BDocs%2Bcollection.%2Cheadline_Docs%2CsiteName_~U2FuaXR5IMOXIE51eHQgVUk%2Cp_Ii9kb2NzL3dyaXRpbmctZG9jcyI%2Cs_cTPlozN5gesR94T-.png" "og:image:height": "630" "og:image:type": image/png "og:image:width": "1200" "og:title": "Writing these docs · Sanity × Nuxt UI" "twitter:image": "https://sanity-nuxtui.vercel.app/_og/d/c_Page%2Ctitle_Writing%2Bthese%2Bdocs%2Cdescription_How%2Bthe%2Bguides%2Bare%2Bwritten%2Bin%2BMarkdown%2Band%2Bimported%2Binto%2Bthe%2BDocs%2Bcollection.%2Cheadline_Docs%2CsiteName_~U2FuaXR5IMOXIE51eHQgVUk%2Cp_Ii9kb2NzL3dyaXRpbmctZG9jcyI%2Cs_cTPlozN5gesR94T-.png" --- > Index of every page on this site: [llms.txt](https://sanity-nuxtui.vercel.app/llms.txt) [Docs](https://sanity-nuxtui.vercel.app/docs) # **Writing these docs** How the guides are written in Markdown and imported into the Docs collection. The guides you are reading live as Markdown files in the `docs/` folder of the repository, readable on GitHub. `pnpm docs:import` turns them into entries of a ****Docs**** collection with the docs layout, served at `/docs`. `pnpm seed` runs the same import. ## Add or change a guide 1. Create or edit a file in `docs/`. Sub-folders are only for your own order; the file name is the slug: `developer-guide/deployment.md` → `/docs/deployment`. 2. Start it with front matter: docs/developer-guide/deployment.md ``` ---title: Deploymentdescription: One-line summary, shown on cards and in search.group: Developer guideorder: 312--- ``` 1. Run the import: ``` pnpm docs:import ``` Running it again updates the entries with the same slug. `pnpm docs:import --prune` also deletes entries whose file was removed. After an import, the entries can still be edited in the Studio, but the next import overwrites them, so keep the files as the source. ## Supported Markdown | **Markdown** | **Becomes** | | --- | --- | | `##`, `###`, `####` headings | Headings, listed in the table of contents | | Lists, bold, italic, `code`, links | The same in rich text | | Links to other `.md` files | Links to their pages under `/docs` | | Fenced code with a language and a file name in brackets, `ts [file.ts]` | A code block with language and file name | | Fences between `` and `` | A code group with tabs | | `> [!NOTE]`, `[!TIP]`, `[!IMPORTANT]`, `[!WARNING]`, `[!CAUTION]` | A callout; a ****bold**** first sentence becomes its title | | Tables | A table | The converter is `apps/studio/scripts/lib/markdown.ts`; the importer is `apps/studio/scripts/lib/docs.ts`. ## The docs layout Any collection can use it: set ****List layout**** to **Docs**. The sidebar groups entries by their ****Sidebar group**** and orders them by ****Order****; entry pages get a table of contents and previous/next links. See [**Collections and entries**](https://sanity-nuxtui.vercel.app/docs/collections). [**Deployment** Host the Studio on Sanity and the site on Vercel, Cloudflare or any Node server.](https://sanity-nuxtui.vercel.app/docs/deployment) ```json {"@context":"https://schema.org","@graph":[{"@id":"https://sanity-nuxtui.vercel.app/#website","@type":"WebSite","name":"Sanity × Nuxt UI","url":"https://sanity-nuxtui.vercel.app/","publisher":{"@id":"https://sanity-nuxtui.vercel.app/#identity"}},{"@id":"https://sanity-nuxtui.vercel.app/docs/writing-docs#webpage","@type":"WebPage","dateModified":"2026-10-16T02:29:18Z","description":"How the guides are written in Markdown and imported into the Docs collection.","name":"Writing these docs","url":"https://sanity-nuxtui.vercel.app/docs/writing-docs","isPartOf":{"@id":"https://sanity-nuxtui.vercel.app/#website"},"potentialAction":[{"@type":"ReadAction","target":["https://sanity-nuxtui.vercel.app/docs/writing-docs"]}]},{"@id":"https://sanity-nuxtui.vercel.app/#identity","@type":"Organization","name":"Sanity × Nuxt UI","url":"https://sanity-nuxtui.vercel.app"},{"@id":"https://sanity-nuxtui.vercel.app/docs/writing-docs#article","@type":"Article","dateModified":"2026-10-16T02:29:18Z","description":"How the guides are written in Markdown and imported into the Docs collection.","headline":"Writing these docs","inLanguage":"en","thumbnailUrl":"https://sanity-nuxtui.vercel.app/_og/d/c_Page%2Ctitle_Writing%2Bthese%2Bdocs%2Cdescription_How%2Bthe%2Bguides%2Bare%2Bwritten%2Bin%2BMarkdown%2Band%2Bimported%2Binto%2Bthe%2BDocs%2Bcollection.%2Cheadline_Docs%2CsiteName_~U2FuaXR5IMOXIE51eHQgVUk%2Cp_Ii9kb2NzL3dyaXRpbmctZG9jcyI%2Cs_cTPlozN5gesR94T-.png","author":{"@id":"https://sanity-nuxtui.vercel.app/#identity"},"image":{"@id":"https://sanity-nuxtui.vercel.app/#/schema/image/1"},"isPartOf":{"@id":"https://sanity-nuxtui.vercel.app/docs/writing-docs#webpage"},"mainEntityOfPage":{"@id":"https://sanity-nuxtui.vercel.app/docs/writing-docs#webpage"},"publisher":{"@id":"https://sanity-nuxtui.vercel.app/#identity"}},{"@id":"https://sanity-nuxtui.vercel.app/#/schema/image/1","@type":"ImageObject","contentUrl":"https://sanity-nuxtui.vercel.app/_og/d/c_Page%2Ctitle_Writing%2Bthese%2Bdocs%2Cdescription_How%2Bthe%2Bguides%2Bare%2Bwritten%2Bin%2BMarkdown%2Band%2Bimported%2Binto%2Bthe%2BDocs%2Bcollection.%2Cheadline_Docs%2CsiteName_~U2FuaXR5IMOXIE51eHQgVUk%2Cp_Ii9kb2NzL3dyaXRpbmctZG9jcyI%2Cs_cTPlozN5gesR94T-.png","inLanguage":"en","url":"https://sanity-nuxtui.vercel.app/_og/d/c_Page%2Ctitle_Writing%2Bthese%2Bdocs%2Cdescription_How%2Bthe%2Bguides%2Bare%2Bwritten%2Bin%2BMarkdown%2Band%2Bimported%2Binto%2Bthe%2BDocs%2Bcollection.%2Cheadline_Docs%2CsiteName_~U2FuaXR5IMOXIE51eHQgVUk%2Cp_Ii9kb2NzL3dyaXRpbmctZG9jcyI%2Cs_cTPlozN5gesR94T-.png"}]} ``` ## Sitemap See the full [sitemap](https://sanity-nuxtui.vercel.app/sitemap.md) for all pages.