Theme a documentation space

groups

label (a heading over each collection) or collapsible (each collection is a disclosure; a collection's nav.collapsed starts it closed).

accordion

true: opening a group closes the others (native, no script). Needs groups: "collapsible".

groupLabel

{size (10–24 px), weight (400–700), case: "upper"|"none", tracking (em), font: "body"|"heading"|"mono", color, colorDark}, or "hide" (kept for screen readers).

item

One row: {size, height, padding, gap, color, colorDark, radius, weight} (px), and lines — 1, 2 or wrap (unset): a longer label is clamped with an ellipsis and its full text is the row's tooltip. The defaults set 2.

active

The current page's row: style — fill, tint, bar, text, solid, outline — plus color, colorDark, background (a hex or tint), backgroundDark, weight, radius, bar (true or {width, color}). The row also carries aria-current="page". The defaults draw a 2px brand bar at the row's start over a soft tint; choosing your own style drops the default tint (except fill) and the bar (unless you set bar).

chevron

start (default), end or none; chevronColor. Leaf rows now line up with their branch siblings' labels. Unset chevronColor, a caret is drawn at 3:1 or better against the rail's background in both schemes.

guideLine

false removes the line beside nested pages.

groupRule, groupDivider, ruleColor

A rule down each collection's list; a hairline between collections. ruleColorDark (hex) is the rules' colour in dark mode; unset, ruleColor holds in both.

width

The rail's width, 200–360 px (default 240). Published as --docs-sidebar-width.

background, backgroundDark, border, borderColor

The rail as its own full-height column, from 768px up. borderColorDark (hex) is the end border in dark mode.

icons

{size, color, colorDark} for page and collection icons.

anchors

Up to 8 quick links ({label, href, icon}) under the search box.

footerLinks, status

Links, and a live status pill (the footer's status shape: {monitorSpaceId, style, color, case, font, dot}), at the rail's foot.

drilldown

Every collection is its own scope (see a collection's nav.navScope).

search

show, hide, or auto — hidden when the header has a search box (still shown inside the phone drawer).

searchHeight

The rail search box's height, 28–48 px (unset: today's 32px plain box; the defaults set 36). Setting it dresses the box like the header's: a magnifier, the chrome.searchStyle.kbd keycaps (which focus this box when no header search answers them) and, when theme.docs.ask is set and not placed in the sidebar, an Ask AI square beside it.

hideable

A button folds the rail away on a wide screen; remembered per browser.

methodBadges

HTTP method pills on API reference pages.

mono

callable: a title ending in () is set in the code face.

searchKbd

The rail search box's key hint: mod-k, slash or none. Unset follows chrome.searchStyle.kbd; chrome.searchStyle.kbdStyle: "plain" draws it as grey text instead of a keycap. { "docs": { "sidebar": { "searchHeight": 40, "searchKbd": "slash" } } }

groupsOpen

current: every collapsible group starts closed except the one holding the page you are on (pinned and unlabelled groups stay open); clicking another opens it. all opens them all. Unset: each collection's nav.collapsed. The defaults set current for a tree of more than five groups. { "docs": { "sidebar": { "groupsOpen": "current" } } }

footerPin

true: the rail's footerLinks sit at the bottom of the full-height rail under a full-width rule, even on a short page. Unset: right after the tree. { "docs": { "sidebar": { "footerLinks": [{ "label": "Status", "href": "/status" }], "footerPin": true } } }

groupLink

What a collection's heading in the rail does. Unset (link): the heading opens the collection's landing page (…/c/{slug}) and the chevron folds the group; the heading is marked current on its own page. toggle: the heading only folds the group, as before. A collection's nav.linkHub overrides this either way.

style

inline (default: the rail is a disclosure above the page) or drawer (a sheet from the edge; the header's menu opens it too, with its links underneath). Without JavaScript the drawer falls back to the disclosure.

label

space (default), section (the current top-level group's name only — "Start with Basalt"), page, trail (the group › page trail, "Start with Basalt › Use Basalt with Next.js"), or your own words. With bar: true and a label other than section, the bar prints the trail as before. The defaults set section.

side

start or end.

bar

A sticky "≡ Section › Page" row under the header, flush against it.

sections

top lists the sections (when sections.placement is header or headerLinks) and your chrome.subnav links above the tree inside the drawer, current one marked, so a phone can leave the section it landed in. none (unset) does not. The defaults set top. Drawer only.

width

sheet (unset: up to 22rem) or full (the whole screen width). Drawer only.

head

true: a head row at the top of the sheet — your brand, the header's first button and a close button — then the search and the light/dark control. The sheet then covers the header while it is open. Drawer only.

mobileNav.scrollToActive

boolean

true

versionSwitcher.labelPlacement (also localeSwitcher)

inside (the select reads "Version: v4") or above (a small caption over the select)

inside

variantSwitcher.style

select, or card — a rounded card showing the current option's icon and name, with no caption

select

variantSwitcher.position

top (the top of the rail) or bottom (under the tree), for the sidebar placement

between the search and the tree

variantSwitcher.options[].icon

A glyph name, an image or an emoji, drawn 20px by the card style — on the card and in each menu row, at every width

none

variantSwitcher.labelPlacement

inside or above — the card style's label as a small caption over the card ("Select your SDK")

inside (no caption)

variantSwitcher.show

auto (only on a page with tabs or a code group carrying its syncKey) or always (every page of its scope)

auto

layout

cards (unset) or list. A collection's own nav.hubCards wins for that collection.

columns

1, 2 (unset) or 3 card columns at desktop widths.

descriptions

false hides each page's one-line summary (its subtitle, else its seoDescription).

updated

false hides "Updated …" on each entry and under the title.

readingTime

false hides "N min read" on each entry.

cover

false hides the collection's coverUrl banner (it is still the social image).

count

false hides "N pages" under the title.

breadcrumb

false hides the trail above the title (space › section › collection). The BreadcrumbList for crawlers stays.

pager

false hides previous (the collection before) / next (this collection's first page).

children

groups (unset): a page with pages under it becomes a titled sub-group. inline: it stays one card with "+N pages".

ask.placement

floating (default — the corner button) | header (a pill in the header's controls) | sidebar (a row at the top of the sidebar) | search (no launcher; the first row of the search modal)

ask.label

≤ 40 chars — the launcher's words. Default "Ask AI", translated

ask.shortcut

boolean — ⌘I / Ctrl+I opens the panel, and the launcher shows the hint

ask.searchRow

boolean — an "Ask AI about …" row at the top of the search modal at any placement

docs.search.scope

space (default) | section — the search modal searches the current docs section first, with a chip to search everything

header.layout

full (default) | sidebar-first (the sidebar runs the full height; the header sits over the article and rail) | rail-split (a brand cell as wide as the sidebar, ruled off). Wide screens only

chrome.brandText

auto (default) | show | hide — the brand's words beside the logo. auto: a wordmark (logoUrl at least 1.8:1 wide, or with a logoMark beside it) carries the name, so the words are for screen readers only; a square mark gets the words beside it

chrome.searchPlacement

center now centres the pill on the header (brand and links | search | controls); before-links puts the search at the far end with the links after it

chrome.header.linksAlign

after-search — the links straight after the search pill ("Search ⌘K · Ask AI")

chrome.searchStyle.width

the pill's width from 768px; it now gives way (down to 160px) before the buttons or "Log in" are crowded out

chrome.headerLinks[].phone, chrome.ctas[].phone, chrome.cta.phone

menu | bar — keep that link or button in the phone row beside search

chrome.headerLinks[].kbd

mod-k | slash | mod-i — keycaps after the link's words; the keys follow the link

chrome.headerLinks[].ink, inkDark, border, borderDark

hex — the link's own colour and outline (a grey pill instead of the brand); ctas[] take inkDark / borderDark too

chrome.signInStyle.order

before-ctas (default) | after-ctas

chrome.subnav.phone

scroll — the section row as one sideways-scrolling row on a phone. subnav no longer needs links, so this also styles the section tabs sections.placement: "header" puts there

chrome.sidebarToggle

true, or { "placement": "end" } — the drawer's button at the far end of the row

announcement.span

page (default) | content — a below-header strip as wide as the article and rail, its left edge on the article's; the sidebar stays flush under the header

announcement.phone

full (default) | lead — below 768px only the lead and the button, one line. Every banner runs edge to edge on a phone

chrome.header.paint

page (default) | brand — the bar painted your brand with a readable ink, under any look (the bold look is this key)

chrome.header.order

the end group's slots in order: search, links, actions, themeToggle, signIn, ctas, menu — e.g. ["themeToggle", "actions", "ctas"]

chrome.header.linksAlign

after-search holds under docs.header.layout: "sidebar-first" too: the links follow the pill in one group. end packs search, links and controls into one group at the end

chrome.searchStyle.label

"" — an icon-only pill ("🔍 ⌘K") that sizes to its content

chrome.searchStyle.kbdStyle

caps (default) | plain — the key hint as grey text

chrome.searchStyle.iconFrame

none (default) | circle | square — a 32px ring around the search: "icon" glyph

chrome.searchStyle.shrink

true (default) | false — keep the pill's width instead of narrowing it first

chrome.logoPhone

full (default) | mark — logoMark instead of the wordmark below 640px

chrome.brandText

also { "show": "auto", "source": "org", "phone": "hide" } — the org's name on a lone space; no words on a phone

chrome.subnav.endLinks

up to 4 items at the end of the section row, dropdowns allowed

chrome.header.menuButton.phone

auto (default) | always | never

chrome.header.menuButton.desktop

true — ☰ at the end from 1024px with your site and footer links

articleAlign

start | center

start lines the article and its text up with the title's left edge instead of centring it in the column. Unset = center. The text track follows layout.measure (unset 48rem)

articleWidth

narrow | default | wide | full, or a measure ("52rem", "70ch", "832px")

The space's default article width. A page's own metadata.layout wins; this beats contentWidth. Imported OpenAPI pages follow it

topRule

boolean | solid | split

The 2px rule under the header. true or solid: one solid line in your brand colour. split: the older two-part stripe (ink for 62% of the width, then the brand). false: none. Unset = shown solid (hidden when white-label, or when motion.ambient.scrollProgress is explicitly false); the documentation defaults (every look except paper) set false, so unset draws it only under look: "paper". Changed: unset and true used to draw the split stripe; see The top rule

pageHead.description

show | hide

The standfirst under the title — metadata.subtitle, else seoDescription. It carries data-fx-lede, so typography.levels.lede styles it

pageHead.breadcrumb

{ show?, separator?: "/" | "›" | ">" | "·" | "chevron", size?: 10–20, collection?: boolean, root?: { label, href? }, home?: boolean, placement?: "head" | "header" }

A trail above the title: the collection (unless collection: false or it is the default one), each parent page, then the page. root leads it. The structured data publishes the same trail. Never drawn on the space's home page (the page the space opens on, or a page hidden from the tree with pageChrome: false) unless home: true. placement: "header" moves it into the header bar beside the rail cell, from 768px, under header.layout: "rail-split" only. The page the space root opens on counts as the home whether or not a home page is named, and a step that repeats the next one ("Payments › Payments") is dropped. phone and style are in the round-4 table below

pageHead.kicker

none | collection | breadcrumb

A small line above the title: the collection's name, or the trail

pageHead.kickerStyle

{ font?: sans|mono|display, case?: none|upper, size?: 10–20, tracking?: -0.05–0.3, weight?: 300–800, color?, colorDark? }

How the kicker looks. Unset: 12px, semibold, uppercase, the eyebrow colour

pageHead.updated

top | footer | hide | actions

Where "Updated …" and the contributors sit. Unset = top. actions leads the actions row with a clock and "Last updated Mar 4, 2026", so the head has one meta row (the contributors stay in the byline)

pageHead.updatedFormat

date | relative | datetime

"Mar 4, 2026", "3 days ago", or the date with the time

pageHead.contributors

boolean

The contributors beside the date. Unset = shown

pageHead.rule

boolean | article | content | column

A hairline under the page head. true/article spans the article; content runs on to the rail's far edge (from 1280px, where the rail sits beside the article) and the rail starts below it, so the rule never crosses the contents list; column runs from the content column's edge to the rail's start edge and stops there

pageHead.titleGap

0–48

The gap between the title and the standfirst, in px. Unset = about 4px

pageHead.icon

boolean

false drops the page's icon before the title; the tree keeps it. Unset = drawn

pageActions.placement

below-title | title-end | rail | none | header

Where the actions bar goes. title-end puts it on the title's row — on a hideTitle page, at the article's top end. header: in the header bar beside the rail cell, from 768px, under header.layout: "rail-split" only (anywhere else it reads as below-title)

pageActions.label

text, ≤ 40

A small mono heading over the actions where they sit in the rail ("AI tools")

pageActions.style

pills | split | menu | text

split: the primary action plus a ▾ menu of the rest; menu: one "Page actions" button; text: inline links

pageActions.items

1–8 of copy, markdown, chatgpt, claude, perplexity, cursor, vscode, mcp

Which targets, in order. Unset = copy, markdown, ChatGPT, Claude, MCP. cursor/vscode install the space's MCP server in one click

pageActions.primary

one of the items

The one shown first (alone, in split)

pageActions.phone

disclosure | icon | bar | text | hide

Under 640px, icon shows glyphs only; text keeps every item as a labelled text link on one row ("Copy page | View as Markdown"), whatever style is; hide drops the bar there. bar: under 768px, one row under the header — the actions as one split control, the variantSwitcher select when the space has one, and a contents button — and the head's own actions and phone contents step aside

toc.levels

{ min: 2–4, max: 2–4 }

Which heading levels the on-this-page rail lists. Unset = h2–h3. A page's metadata.tocLevels wins

toc.steps

boolean

Also list stepper step titles

toc.label

text, or false

The rail's heading; false hides it (the list keeps its accessible name)

toc.labelCase / labelSize / labelFont / labelColor / labelColorDark / labelIcon

upper|none / 10–20 / sans|mono|display / #hex / #hex / boolean

The label's look

toc.itemSize

11–18

The entries' size in px

toc.activeColor / activeColorDark / activeStyle

#hex / #hex / bar | text | fill

The current entry: a bar (default), coloured text only, or a soft fill

toc.extras

up to 4 of backToTop, feedback, edit, actions

What stacks under the rail, in this order. The rule between them and the contents list is drawn only when the list is (a page with too few headings has none)

toc.extrasPlacement

before | after

before stacks the extras above the contents list. Unset = after

toc.phone

hide | disclosure | select

Under 1280px, where the rail is hidden: nothing (default), a collapsible list, or a "Jump to a section" select — after the whole page head (title, standfirst or lede, the meta row and byline), 16px below it. toc.phonePlacement moves it

panel

{ background?, backgroundDark?, border?, borderColor?, borderColorDark?, radius?: 0–32, inset?: 0–48 or { top?, right?, bottom?, left? } (each 0–48), padding?: 0–80 or {sm,md,lg}, shadow?: none|sm|md, includeRail?, phone? }

An inset surface around the article (and the rail, with includeRail), from 768px up — from 0px with phone: true, padded by padding.sm (unset 20px). A number inset is the gap at the right and bottom; the object sets each side (a side left out keeps that reading)

aside

{ width?: measure, top?: 0–200 }

The lifted aside column (a column with role: "aside"): its width (unset 24rem) and sticky offset in px

hideTitle

boolean

Hides the title on screen; it stays the page's <h1> for screen readers and search

subtitle

≤ 300 chars

The standfirst, when it should differ from seoDescription

hideUpdated

boolean

No "Updated …" on this page

hideCover

boolean

Keeps coverUrl for the share card, not on the page

layout

narrow | default | wide | full | center | custom

center: no tree, no rail, centred. custom: no tree, no rail, no width cap, title for screen readers only, no page chrome

template

doc | splash

splash: a hero instead of the title, no rail, full width, no page chrome

hero

{ title?, tagline?, image?, imageDark?, imageAlt?, actions?: up to 4 { text, href, variant?: primary|secondary|minimal, icon? }, layout?: stack|split, align?: start|center, titleSize?: length }

The splash hero. title defaults to the page title. titleSize (72, "4.5rem", "clamp(…)") sets the hero title's size, capped at 12vw on a phone; unset = 36px, 48px from 768px

tocLevels

{ min, max } or null

This page's rail depth

pageChrome

boolean

false drops the actions bar, "Updated", feedback and previous/next

titleAlign

start | center

Centres the page head

hero.alignPhone

start | center

The hero's alignment below 768px, where a split hero stacks. Unset = follows hero.align. Example: { "hero": { "align": "start", "alignPhone": "center" } }

themePatch

{ components?, docs?: { pageHead?, toc?, articleWidth?, pageActions?, frame?, panel?, feedback?, pager?, api?: { titleSize? }, blocks?: { prompt?: { icon? } } } } or null

This page's own slice of the theme — see Per-page theme below

pageHead.breadcrumb.phone

theme / page

full | collapse | parent | hide

full (the whole trail, wrapping). The DOCS default layer sets collapse

{ "pageHead": { "breadcrumb": { "phone": "collapse" } } } — below 640px the first and the last two steps on one line, the middle behind a "…" that unfolds in place; parent = one "‹ Parent" link; hide = no trail on a phone

pageHead.breadcrumb.style

theme / page

trail | kicker

trail

{ "pageHead": { "breadcrumb": { "style": "kicker" } } } — no trail; the page's section (its nearest group) as a small upper-case eyebrow above the title, unlinked, in kickerStyle's look

pageHead.rule: "column"

theme / page

see pageHead.rule

—

{ "pageHead": { "rule": "column" }, "toc": { "border": true } }

pageActions.phone: "text" / "hide"

theme / page

see pageActions.phone

—

{ "pageActions": { "style": "split", "phone": "text" } }

pageActions.phoneToc

theme / page

text | icon

text

{ "pageActions": { "phone": "bar", "phoneToc": "icon" } } — the phone bar's contents button as the glyph alone (its label stays the accessible name)

toc.phonePlacement

theme / page

after-head | after-title | hide

after-head

{ "toc": { "phone": "select", "phonePlacement": "after-title" } } — after-title puts the phone contents straight under the title; hide removes it (and the phone bar's contents button) on phones

toc.border / borderColor / borderColorDark

theme / page

boolean / #hex / #hex

none / the hairline colour

{ "toc": { "border": true, "borderColor": "#e4e4e7" } } — a full-height rule down the rail's start edge, from 1280px

toc.extrasOnAside

theme / page

below | hide

below

{ "toc": { "extrasOnAside": "hide" } } — where the rail holds a lifted aside or the API pane, the extras go under it (always, even with extrasPlacement: "before"), or not at all

pageHead.rule: "bleed"

theme / page

a new value of pageHead.rule

—

no

{ "pageHead": { "rule": "bleed" } } — the hairline runs from the content column's outer edge (the sidebar's border) to the rail's border (with no rail beside it, the content area's edge), from 768px

pageHead.ruleColor / ruleColorDark

theme / page

#hex

the line colour

no

{ "pageHead": { "rule": "bleed", "ruleColor": "#e4e4e7", "ruleColorDark": "#3f3f46" } } — every rule spelling (article, content, column, bleed) takes it

pageHead.breadcrumb.kickerCase

theme / page

upper | none

upper

no

{ "pageHead": { "breadcrumb": { "style": "kicker", "kickerCase": "none" } } } — the section eyebrow as written ("Sending", not "SENDING")

pageHead.breadcrumb.kickerColor / kickerColorDark

theme / page

#hex

kickerStyle.color, else the eyebrow ink

no

{ "pageHead": { "breadcrumb": { "style": "kicker", "kickerColor": "#71717a" } } }

pageHead.breadcrumb.kickerSize

theme / page

px 11–16

kickerStyle.size, else 12px

no

{ "pageHead": { "breadcrumb": { "style": "kicker", "kickerSize": 13 } } }

pageActions.phoneIcon

theme / page

primary | code

primary

no

{ "pageActions": { "phone": "bar", "phoneIcon": "code" } } — the phone bar's split button wears the PRIMARY item's own glyph (the copy glyph for "Copy page"); code is the code glyph it used to show for every item

toc.onHero

theme / page

show | hide

show

hide

{ "toc": { "onHero": "hide" } } — a page that opens with a hero has no on-this-page rail and the article takes its width. A hero is: metadata.hero with a title or tagline; a first body block that is a section; a first block hooked or classed hero; or a hideTitle page's first heading. Decided on the server, so nothing shifts. A page's metadata.themePatch { "docs": { "toc": { "onHero": "show" } } } keeps its rail

card.background / backgroundDark

#hex

Fills every card

card.iconAlign

start | center

start: the panel look's glyph in the top-left of its well, and the horizontal/row looks' icon at the top. center: the icon (and the text) centred over a stacked card, and centred on the row in the horizontal/row looks

card.ctaPlacement

below | end

horizontal cards: end puts the CTA at the row's end, vertically centred

card.border

card | tile | none

card is today's outline. none drops it; tile drops it and rules only the icon, as a 40px tile

table.more

{ style?: outline|solid, align?: start|center, fade?: boolean }

A collapsed table's "Show more": the outline pill (unset) or a solid brand button, at the start or centred, and fade fades the last visible rows into it

table.codeInk / codeInkDark

up to 6 #hex

Inline code colour per column, first column first — a class column in one ink, a value column in another

stepper.markerSize

16–48

The marker's diameter in px. Unset = 25.6

stepper.markerAlign

first-line | title

title centres the marker on the step title's line (the line is set to the larger of the marker and 1.4 × titleSize). Unset/first-line = top-aligned

hint.variants.<style>.titleGap

0–24

The gap under that callout style's title, in px (also published as --hint-title-gap on the callout). Unset ≈ 5.6px

blocks.prompt.variant

card, compact, pill

compact on a DOCS space (the DOCS layer); unset elsewhere, which is card

The look a prompt block takes when it names no variant of its own. A prompt that sets one keeps it.

blocks.prompt.layout

inline, stacked

inline

Round 4: stacked puts the actions under the text.

blocks.prompt.primary

copy, open

neither

Round 4: that action is drawn filled in the brand.

blocks.prompt.copyStyle

button, icon

button

Round 4: the copy control as the glyph alone.

blocks.prompt.phoneTargets

1–6

1 under compact

Round 4: the "Open in …" links a compact prompt keeps in its phone row; the rest go under More.

blocks.prompt.openInDesktop

0–6

all (today). The DOCS layer sets 2

Round 5: the "Open in …" links any prompt keeps in its row from 641px; the rest fold into a More menu drawn on the server (a native disclosure: Enter/Space open it, Escape closes it). Example: { "docs": { "blocks": { "prompt": { "openInDesktop": 2 } } } }

blocks.prompt.icon

a glyph name, or a short glyph

none

Round 5: drawn before the label of every prompt that names no icon of its own. Example: { "docs": { "blocks": { "prompt": { "icon": "sparkles" } } } }

blocks.prompt.labelCase

upper, none

upper

Round 5: none sets the label as written.

blocks.prompt.background / backgroundDark

#hex

today's surface

Round 5: the prompt's fill, light and dark. A prompt's own attrs win.

blocks.prompt.collapseStyle

footer, pill

footer

Round 5: a folded prompt (collapse) shows "Show more" as today's full-width bar, or as a floating "⌄ Show more" pill centred over the fade.

blocks.prompt.labelSize

10–20 (px)

11.2px (0.7rem); 14px on a compact row

Round 6: the label's size. Example: { "docs": { "blocks": { "prompt": { "labelSize": 14, "labelWeight": 500, "labelCase": "none" } } } }

blocks.prompt.labelWeight

100–900

600

Round 6: the label's weight.

blocks.prompt.labelColor / labelColorDark

#hex

the muted grey (ink on a compact row)

Round 6: the label's colour, light and dark.

blocks.prompt.divider

boolean

drawn

Round 6: false drops the rule under the head (and over a stacked actions row) — one undivided card.

blocks.prompt.actionsAlign

start, end

inline: Copy beside the label, "Open in …" at the end; stacked: from the start

Round 6: where Copy and "Open in …" sit in their row, as a group. Card rows only (a one-row compact and the pill keep their order); a prompt with its own align keeps it.

components.code.tabFont

ui | mono

The code group's tab labels (and its dropdown picker): ui sets them in the body face, mono in the code face. Unset = the code face. Published as --code-tab-font, which the API reference's sample tabs read too

layout

stacked, split

stacked

split: on a page with exactly one top-level operation block, at ≥1280px the code samples, responses and "Try it" sit in a sticky pane beside the operation, in the width the on-this-page rail gave up (the rail is dropped on that page). Below 1280px it is one column: samples, then responses. A block's own layout attr wins.

params

table, list

table

list: parameters and fields as rows (name, type, required, description) with nested children behind "Show child parameters". A block's own params attr wins.

sdkPanel

every, landing, none

every

Where the SDK download panel mounts. landing: only on the reference's landing page (after its first paragraph), or on an unlabelled page that has an operation block.

examples.languages

up to 10 of curl typescript python go php ruby java csharp kotlin swift

the first seven

Which sample languages, in this order.

examples.default

one of the above

—

The tab shown first, until the reader picks one (their pick is remembered).

examples.picker

tabs, dropdown

tabs

A select instead of a tab strip.

examples.tabStyle

underline, pill

underline

The language strip's look. pill: small rounded pills, the active one tinted. Either way the strip is ONE row that scrolls sideways when the languages outgrow it — it never wraps.

examples.lineNumbers

boolean

false

A numbered gutter on every sample — the code block's own (numbers are never copied).

playground.display

interactive, simple, none

interactive

simple hides the header editor and the proxy toggle; none drops "Try it" and its payload.

playground.open

boolean

false

Open the console on load.

playground.prefill

boolean

false

Start parameters at the spec's examples.

playground.rememberAuth

page, session

page

session keeps credentials for every console of this space in this browser tab (sessionStorage, keyed by space and scheme, cleared when the tab closes — never localStorage), with a Forget button. Signed-in prefill from the reader's claims is not built.

specLink

boolean

false

An "OpenAPI spec" download link in each operation's head row (…/api-export/spec).

paramName.chip

boolean

true

false: parameter and field names as a bare bold mono name — no border, no fill. The DOCS default layer sets false. Example: { "api": { "paramName": { "chip": false } } }

textSize

12–18 (px)

today's sizes

The size of descriptions in parameters, fields, the body and responses. The DOCS default layer sets 14. Example: { "api": { "textSize": 14 } }

bodyHeading

disclosure, plain

disclosure

plain: the body's heading is a plain "Parameters" title (no ▾, no media type) — "Request body" when a path/query Parameters table is also there — and the Parameters section stops folding too. Example: { "api": { "bodyHeading": "plain" } }

url

full, path

full

path prints /emails rather than https://api.example.com/emails in the head (samples still call the full URL).

urlStyle

chip, pill

chip

pill: method and address as ONE bordered pill — "POST /emails", the method in its colour as text — that never wraps (it scrolls inside itself on a phone). Example: { "api": { "url": "path", "urlStyle": "pill" } }

phone.samples

after-params, first

after-params

Below 768px: first puts the code samples straight after the description.

phone.frame

boolean

true

false drops the operation's bordered card below 768px. Example: { "api": { "phone": { "samples": "first", "frame": false } } }

phone.url

full, path

full

Round 5: the address below 768px. path drops the server URL there ("POST /v11/projects"); desktop keeps url's choice. The DOCS layer sets { "frame": false, "url": "path" }. Example: { "api": { "phone": { "url": "path" } } }

urlStyle: "plain"

a new value of urlStyle

—

Round 5: the address as bare mono text — no chip, no border, no fill. With components.apiRef.methodStyle: "text" the head is two words of text. Example: { "components": { "apiRef": { "methodStyle": "text" } }, "docs": { "api": { "urlStyle": "plain" } } }

titleSize

px 20–48, or { "sm"?, "lg"? }

the theme's h1

Round 5: the page title's size on an OPERATION page (one carrying an API operation block) — guide pages are never touched. sm is below 768px, lg from it. Also accepted per page in metadata.themePatch.docs.api. Example: { "api": { "titleSize": { "sm": 24, "lg": 28 } } }

responses.style

list, panel

list

Round 5: panel attaches the example response under the code samples as a pale panel with a small "RESPONSE" strip; the status list folds into the strip's select (no JS: the first response shows).

responses.background / backgroundDark

#hex

a 4% ink wash

Round 5: the panel's surface, light and dark.

responses.ink / inkDark

#hex

the reader ink

Round 5: the response body's text on the panel. The code blocks' ink is often meant for a dark block, so the panel no longer borrows it.

responses.header

label, none

label

Round 5: none drops the strip's "Response" word and keeps the select. Example: { "api": { "responses": { "style": "panel", "background": "#f6f8fa", "backgroundDark": "#161b22" } } }

show

false removes the widget. Page views are still counted.

shown

placement

foot, rail (under the on-this-page list on wide screens; the foot keeps a copy for phones)

foot

style

buttons (Yes / No), pill (one rounded control), thumbs (icons only, after the label), labelled (round 5: worded buttons with no glyph)

buttons

third

true adds an "I have feedback" button that opens the comment form straight away (a comment sent from it is filed as a comment with no verdict — rating: "comment", outside the yes/no counts; Skip sends nothing). Round 5

none

labels

{ "yes"?, "no"?, "other"? }, each up to 40 characters — the buttons' words (the third button's too). Round 5

"Yes" / "No" / "I have feedback", translated

scale

2 (up / down) or 4 (four steps, sent as score)

2

align

start, center, end

start

label

Up to 80 characters

"Was this page helpful?", translated

comment

When the comment box opens: down (after a negative vote), always, none

down

placement

sidebar, header (with the header's controls), brand (beside the logo)

sidebar

style

pills, select (a compact menu that works without JavaScript)

pills

label

Up to 40 characters, or false to hide it

"Version" / "Language", translated

Site-wide meta tags

customHead on …/analytics-tags; its <meta> and <link> tags render on every host.

Scripts on documentation pages

Theming, advanced → Which consent tier: scripts run only on a verified custom domain.

Title pattern, site name, hidden pages in search

seo.titleTemplate, seo.siteName, seo.indexHidden (theming-advanced, SEO keys).

Page keywords

metadata.keywords.

Paper and ink

neutral white / near-black, dark #0b0b0f

palette, paletteDark

Type

UI sans, 16px body on 1.6, H1 36px 600 −0.02em, H2/H3 600

fonts, typography

Header

always on: logo, search pill centred on the header with a ⌘K chip, ONE theme button that cycles system → light → dark

chrome.search, chrome.searchPlacement, chrome.searchStyle, chrome.themeToggle.style (cycle)

Brand words

beside a square mark; screen-reader only beside a wordmark (no "Acme" image + "Acme" text)

chrome.brandText

Brand repeat

no brand at the top of the sidebar (a lone space; inside a site the site decides)

chrome.sidebarBrand

Article

start-aligned with the title

docs.articleAlign

Sidebar groups

collapsible, sentence case, 600, 14px, ink; chevron at the end

docs.sidebar.groups, .groupLabel, .chevron

Active row

brand text, 600, soft brand tint

docs.sidebar.active

Sidebar

272px; its search box hides when the header has one (36px tall when shown); API method badges; a long label clamps to two lines

docs.sidebar.width, .search, .searchHeight, .methodBadges, .item.lines

Phone

a drawer, labelled with the section, opening on the section list

docs.mobileNav (sections: "top")

Page actions

one split "Copy page ▾" at the title's end; an icon on a phone

docs.pageActions

Updated

in the page footer

docs.pageHead.updated

Breadcrumb

shown (never on the space's home page)

docs.pageHead.breadcrumb

Title → lede

16px

docs.pageHead.titleGap

Prompt block

the compact look

docs.blocks.prompt.variant

Stripe under the header

none

docs.topRule

On this page

sentence-case 13px label; stepper steps indexed; a disclosure on phones

theme.docs.toc

Code

copy icon, language chip, neutral block and inline surfaces, the github code theme — only where you chose no code colour

components.code, codeDark, syntaxTheme

Links

underlined when your brand is under 3:1 against the ink (so a link is findable without colour)

components.link.underline

Tables

hairline rows, compact, no zebra

components.table

Lists

a muted dash

components.list.marker

Tabs, steps, keys

scrolling tab rows, outlined step markers on a line, keycaps

components.tabs, components.stepper, components.kbd

Pager

cards

docs.pager.style

Feedback

a pill

docs.feedback.style

API reference

two-pane at ≥1280px, the SDK panel on the landing page only, parameters as a list

theme.docs.api

Ask AI

a floating launcher, plus an "Ask AI" row in search

theme.docs.ask

A lone logo in dark mode

drawn inverted — a lone logoMark too (not when you pinned dark or uploaded a dark logo)

logoDarkMode

PDF of the space

off

settings.readerTools.pdf

clean

Neutral white paper, a UI sans, hairline tables, a quiet sidebar, the documentation defaults below

muted

clean with the canvas on the soft grey surface tone and a tinted sidebar

bold

clean with a solid active sidebar row and the header painted in your brand (its text picked to read on it)

panel

clean with the article in an inset panel on the panel tone (the page's panel key)

dark

clean, pinned dark — your own colorScheme still wins

paper

The documentation defaults OFF: the warm paper and every reader default as they were before 2026-10

--bg

#ffffff

#0b0b0f

--surface

#fafafa

#111114

--panel

#f4f4f5

#08080b

--ink

#0f1115

#ededef

--muted

#5d636b

#a1a1aa

--ink-3

#676c75

#8b8b94

--line

rgba(15,17,21,.12)

rgba(237,237,239,.12)

--line-strong

rgba(15,17,21,.3)

rgba(237,237,239,.3)

--line-control

rgba(15,17,21,.5)

rgba(237,237,239,.42)

--grid

rgba(15,17,21,.04)

rgba(237,237,239,.04)

--docs-sidebar-width

docs.sidebar.width

15rem; 272px under clean

--docs-content-width

the article's max width

the page width

--docs-nav-height

the header's rendered height

—

--docs-ui-font

the clean look

the platform UI sans

The solid brand line

{ "docs": { "topRule": true } } (or "solid")

The old split stripe

{ "docs": { "topRule": "split" } }

No rule

{ "docs": { "topRule": false } } — what every look except paper already does

muted

palette.paper: "soft", docs.sidebar.background: "#f4f4f5", docs.sidebar.backgroundDark: "#111114"

bold

chrome.header.paint: "brand", docs.sidebar.active: { "style": "solid", "bar": false }

panel

palette.paper: "grey", docs.panel: { "radius": 16 }

dark

colorScheme: "dark"

paper

nothing: the documentation defaults are off, and every unset key renders as it did before 2026-10

frame.tree

show, hide

show on a documentation space

The page tree beside the content, on articles, hubs, tag pages and a framed front door

frame.rail

show, hide, auto

the page as it was

The on-this-page rail's default; auto draws it only for a page with four or more H2s. onThisPage (space or page) still wins

frame.front

tree, bare

what the stored front page says: framed when its sidebar is the docs tree (sidebar.source: "docs-nav"), else bare

The space's front door (its landing or composed front page). tree puts it inside the docs frame with the page tree beside it, whatever the front page says; bare is full width with no tree

/<mount>

The front door: the home page (homeAt: "root"), a landing or a composed front page, framed per frame.front

/<mount>/<page>

A page. /<mount>/<version>/<page> is the same page in another version

/<mount>/c/<slug>

A collection's hub — theme.docs.hub. In the sitemap per language

/<mount>/tags/<tag>

Every page carrying metadata.tags <tag>, as hub cards with a count, in the docs frame. It reads theme.docs.hub too. A tag no page carries is a real 404 with no canonical

/<mount>/<page>.md

The page as Markdown, in the address's language

/<mount>/print

The whole space as one printable document (settings.readerTools.pdf), with its own title, noindex, in the address's language

/<mount>/updates.xml

RSS of recently changed pages, linked by slug. /<mount>/<lang>/updates.xml is the same feed in that language

/<mount>/<lang>/…

Every address above in a published language. The root and hubs name themselves canonical per language, with hreflang alternates

ask.suggestions

up to 6 questions, 120 characters each

none

One-click starter questions in the empty Ask AI panel (and in the Ask AI launcher widget)

ask.handoff

{ href, label?, when?: "unhelpful" | "always" }

none

"Ask a person instead" under an answer, opening href (a path on your site or an https link) with {question} filled in. unhelpful: after a "No"; always: every answer

theme.docs.search.placeholder

≤ 80 characters

chrome.searchStyle.label, else "Search" translated

The docs search's words, in the rail and in the header on this space

theme.docs.search.facets

boolean

off

A row of section chips with counts in the search dialog that narrows the hits

theme.docs.search.algolia

{ appId, searchKey, indexName }

our own search

Search with your Algolia DocSearch index instead (see What you need to set up)

header.hideOnScroll

boolean

the header stays

The header slides away while the reader scrolls down and returns on the first scroll up

header.github

{ repo: "owner/name", stars?, label?, placement?: "sidebar" | "header" }

none

A repository button; stars adds the live star count, fetched by our server and cached for an hour (a reader's browser never calls GitHub). sidebar (default) or header

offline.enabled

boolean

off

Readers keep the pages they opened for offline reading. Never a signed-in, shared-link or network-limited page; turning it off retires installed copies

pageHead.readingTime

byline, actions, hide

none

"6 min read", counted from the page body

pageHead.owner

byline, hide

none

"Maintained by …" from the page's metadata.owner

pageHead.updatedFormat

(existing)

—

Now honoured in the actions row too (updated: "actions")

pageActions.custom

up to 4 { label, urlTemplate, icon? }

none

Your own actions after the built-in ones. {url}, {path}, {title} and {markdownUrl} are URL-encoded into an absolute http(s) template

availability

{ show?: "both" | "nav" | "title" | "none", notice?, labels? }

both, notice on

How a page's metadata.availability stage reads: a pill in the tree and beside the title, your own word per stage, and a notice above a deprecated page's body

sidebar.collapseDepth

0–6

the branch on the current path opens

Tree levels at or above this start open (collections are level 1); deeper ones start collapsed. groupsOpen still decides the groups

related

{ show, source?: "auto" | "manual", count?: 1–12, placement?: "foot" | "rail", style?: "list" | "cards", label? }

not shown

"Related pages". auto ranks pages sharing this page's tags, then its siblings; manual lists only metadata.related. Default 4, at the foot, as a list

versionSwitcher.banner

{ show?, wording?, style?: "note" | "strip" }

only a version's own banner (unreleased, unmaintained)

show: true adds "You are reading the docs for {version}. The latest is {latest}." with a link, on every older version; false shows none

versionSwitcher.badge

boolean

none

A chip with the version's name beside the title

versionSwitcher.remember

boolean

no memory

A version the reader picked is where the root and version-less addresses open next time

editLink.urlTemplate {locale}

a new placeholder

—

The reader's language (empty on the original), for repositories that keep one file per language

blocks.code.wrapToggle

boolean

none

A "wrap long lines" button on every code block

api.examples.params

all, required

all

required keeps only required fields and query parameters in the generated samples, for a call a reader can paste and run

api.examples.auth

{ placeholder, personalize? }

no credential

What the samples show for the key or token (Bearer YOUR_API_KEY); personalize swaps in the token the reader saved in "Try it" (playground.rememberAuth: "session"), in their browser only

api.collections

{ kinds?: ["postman", "insomnia", "bruno"], runInPostman? }

none

Download links for the space's own collections beside each operation, and a "Run in Postman" button for your published collection link (a postman.com address)

api.asyncapi

{ verbs?: "send-receive" | "publish-subscribe", messageExample?: "show" | "hide", protocol? }

send-receive

How AsyncAPI channel pages name their operations, whether the example message shows, and a protocol chip (WS, MQTT, AMQP…)

availability

alpha, beta, preview, ga, deprecated, experimental, new

The release stage of what the page documents, drawn per theme.docs.availability

owner

a member's id

Who keeps the page true: named in the byline (pageHead.owner), listed on the stale-page report, and reminded to review it (see settings.docsReview below)

related

up to 12 slugs or ids

This page's own related pages; they lead the related list

navClass

one class name

A CSS class on the page's tree row, for customCss

navData

up to 8 { key: value }

Written as data-nav-<key> on the tree row

nofollow

boolean

robots: nofollow on this page, independently of noindex

docs-page-header, docs-page-footer

Above and after the article

page.title

docs-sidebar-start, docs-sidebar-end

Top of the left rail under the brand; foot of the rail

—

docs-rail, docs-rail-end

Top of the right rail (above "On this page"); foot of the right rail

page.title

docs-hub-above-list, docs-hub-below-list

A /c/<slug> hub or a tag page, above and below its list

collection.title, collection.slug

settings.readerTools.search

on

The search box in the rail

settings.readerTools.pdf

off

The PDF / print link and /print

settings.readerTools.copyMarkdown

off

A separate "Copy page" tool (the actions bar already copies)

settings.readerTools.aiActions

on

"Open in ChatGPT / Claude"

settings.readerTools.mcp

on

"Connect with MCP"

settings.docsReview.afterDays

off

7–730. A page with an owner that goes unedited this long sends its owner one review reminder per interval (checked daily)

settings.networkAccess

everyone

Limit the space to some networks — see Limit a space to some networks

seo.metatags

none

Up to 20 { name, content } <meta> tags on every page (PUT …/seo). Names the reader writes itself (description, robots, og:*, twitter:*) are refused

Algolia DocSearch

Your Algolia Application ID, the search-only API key (never an admin key), and the index name

theme.docs.search.algolia, in Look → Docs reader: every setting → Header, search and Ask AI

Our own search

Run in Postman

A published Postman collection link from your Postman workspace

theme.docs.api.collections.runInPostman

No button (the Postman/Insomnia/Bruno downloads need nothing)

Analytics and chat vendors

Each vendor's public site or project ID

Your space's or organization's analytics settings

No script is loaded

Live code playgrounds

Nothing from you: a sandbox domain on Forumulate's side

—

The block's fallback picture

Public_search

GET /public/orgs/{orgId}/spaces/{spaceId}/search

Get the search in a space (public reader)

client.public.search()<br>MCP search_docs