Site settings

Project display name. Used as the page title fallback, in the navbar (when no logo is set), and in OpenGraph/SEO tags. Defaults to the value you picked at project creation.

Repo folder containing your MDX files. Must end with /. The sync pipeline ingests only files under this prefix — anything else in the repo is ignored.

Which icon library resolves icon names when your MDX or nav config uses icon="rocket". Unknown names silently fall back to the text label.

The banner text. Markdown links work: [text](/path).

Colour treatment. primary uses your brand colour; info uses blue; warning uses amber.

When true, shows a close button. Dismissed state is held for the rest of the session (not persisted).

The colour scheme shown when a visitor has no preference stored.

Hides the theme toggle entirely. Use when your brand demands a single, forced mode.

Default page title. Page frontmatter title wins when present. Final format: {page title} | {seo.title}.

Default meta description. Page frontmatter description wins when present.

URL or repo-relative path of the Open Graph image. 1200×630 PNG recommended for Twitter/LinkedIn/Slack. Applied to og:image and twitter:image.

When noindex, a robots: noindex, nofollow meta tag is emitted on every page. Use for staging sites or private docs.

Free-form meta-tag map. Keys become <meta name="KEY" content="VALUE">. Appended to every page. Common keys: twitter:site, theme-color, color-scheme, robots.

Path to a favicon (SVG preferred). Applied as <link rel="icon"> globally.

Placeholder text in the search bar. Plain text only.

URL path to match. Trailing /* enables prefix matching; the matched tail is preserved when the destination also ends in /*.

Where to send the visitor.

When true, returns HTTP 308 (permanent). Otherwise 307 (temporary). Search engines respect 308 and transfer ranking signals to the new URL.

Text links rendered in the top bar, left of the primary CTA. Each needs a label + href.

A root-relative href (/pricing) is resolved against your site's base path, so it keeps working when the docs are served under a subpath like acme.com/docs. Write the path as it appears in your navigation and leave the prefix to us. Absolute URLs are used as given.

Where the navbar's controls sit, and in what order. Each accepts "header", "sidebar", or "auto" (the default — follow the theme).

Every theme already has an opinion about each control — some put the appearance toggle at the bottom of the sidebar and keep the language switcher in the header, others group them. Setting a control here overrides the theme for just that control, so you can move one without disturbing the rest.

order re-sequences whichever controls end up in the header, left to right. Anything you leave out keeps its usual position after the ones you list — so ["appearance"] pulls the toggle to the front and leaves the rest alone.

On the headerless themes (slate, larch) the rail is the default home for all of them, since there is no header row to stack them in — the assistant excepted, which stays beside the CTA where a reader looking for an action finds both. Setting a control to "header" still moves it there.

Call-to-action button pinned to the right of the navbar, just before the light/dark toggle. Use it for the most common next step (Dashboard, Sign in, Start free). Omit the block entirely to hide the button.

Shape of the button. solid is a filled pill, outline draws a border with no fill, and ghost is text only — useful when the CTA shouldn't outrank the docs themselves.

Fill (or border) colour — any CSS colour. Leave it out and the button follows your theme's accent, which is the right choice for most sites. Set it when the CTA belongs to a product whose brand colour differs from the docs theme.

Label colour on a solid button. Leave it out to follow the theme.

Open in a new tab. Defaults to true for http(s) targets and false for docs paths, so you rarely need to set it.

An external target opens with rel="noopener" — it cannot reach back into the docs tab, and it does arrive with a referrer. That second part is deliberate: your own analytics will show these visits as coming from your documentation rather than as Direct, which is the number that tells you whether the docs are doing their job. The same applies to external navbar tabs, sidebar anchors and dropdown items. Links written inside a page keep rel="noopener noreferrer", since those point anywhere on the web.

Which shell frames the page. header-sidebar is a header bar above a sidebar, sidebar-first drops the header so the rail runs full height, and header-only has no rail at all. The largest of these overrides — it swaps the whole frame, not just where the tabs sit.

Where navigation tabs render — across the header, or down the sidebar as a list or a dropdown.

How many rows the header takes. 0 removes the header bar, 1 keeps tabs on the logo row, 2 gives them their own strip beneath it.

How header tabs are drawn.

Horizontal placement of single-row tabs. Ignored when headerRows is 2, where the strip spans the full width anyway.

How the current page is marked. bg-tint fills a pill behind it. text-only draws a thin rail down every row with an accent bar on the active one. text-tint colours the label and paints nothing else — the quietest, for content-heavy sidebars where a pill competes with the text. caret puts a chevron in the margin beside the active page and draws no rail at all; the marker sits outside the row, so labels stay on one line as you navigate.

Whether per-page icons appear. A string rather than a boolean so that "off" stays distinguishable from "not set" — "false" hides icons even on a theme that shows them.

Whether the sidebar's scrollbar is always drawn or fades in on hover. Touch devices never show one either way.

Casing and weight of group headings. uppercase reads as formal section markers; normal sits closer to the pages beneath it.

Whether groups get a chevron toggle. "false" keeps every group open with no toggle at all — best for a short sidebar where hiding anything costs more than it saves. A string rather than a boolean so "off" stays distinguishable from "not set".

How collapsible groups start. expanded opens all of them; collapsed opens only the group holding the current page and leaves the rest shut — the default. Has no effect when groups aren't collapsible, since there is nothing to close.

A per-group expanded in your navigation still wins over this, so you can force one section open regardless.

• dropdown (the default) — one control stating the current variant. Stays one line however many variants a page offers.

• tabs — the variants spread in a row. Reads well for two or three; wraps into several rows past that, and stacks against any tabs the page itself uses.

How fenced code blocks are framed.

• auto — follow the theme. Most themes draw card; Larch draws inset and Terminal draws terminal.

• card — a bordered block with a filled header strip carrying the language and the copy button.

• inset — no border. The block is a soft raised surface with the code recessed into a darker well inside it, so depth does the separating instead of an outline. Suits pages that read as one continuous canvas.

• terminal — sharp corners and a $ prompt marker before the language, for docs whose examples are mostly commands.

none hides your footer content — logo, social, legal links, and copyright are all suppressed even if you've set them, so it's a real off switch (free-plan sites still keep the small "Powered by NookDocs" mark). page renders a compact footer beneath the page content — a single social-icon + copyright row when that's all it holds, expanding to a two-tier layout (brand on top, legal + copyright below) when you add a logo or legal links. columns renders a multi-column link grid with the social row and a legal row below.

How wide the footer's surface runs — independent of footer.style, so it applies to page and columns footers alike. reading (the default) lines it up with the reading column — the same narrow width as your page text and the "Was this helpful?" feedback block. content widens it to the article + table-of-contents column. full spans the whole viewport — including under the sidebar, which stops at the footer's top rule — so the footer reads as a bar closing the page. A columns footer reflows its link columns to fit the chosen width. Leave it out to follow your theme, then the reading default.

Show your site logo in the footer. Reuses colors.logo — no separate upload or path. In columns style it sits with the social icons on the left, beside the link columns; in page style it moves the footer into its two-tier layout, with the logo above the social row.

Platform slug → profile URL. Rendered as brand icons in the page footer (set style to page or columns to show them). Supported slugs: github, x, linkedin, discord, youtube, facebook, website, slack, instagram, hackernews, medium, telegram, bluesky, threads, reddit, podcast. (twitter is accepted as an alias for x.)

Column definitions. Each column has a title and an array of links. Only rendered when style: "columns".

Catch-all font family — used when a single face serves both display and body text. Sets --docs-font-sans.

Font stack applied to headings (--docs-font-heading). Falls through to fontFamily when omitted.

Font stack for paragraph + inline content (--docs-font-body). Falls through to fontFamily when omitted.

Enable the custom 404 page. When off, falls back to the platform default.

Headline shown on the 404 page.

Subtitle copy. Supports markdown.

When set, the 404 page is skipped and the visitor is server-side redirected here instead. Common pattern: "/introduction" — missing URLs fall back to the first real page. Takes priority over title/description when both are set.

Show "Last updated on DATE" at the bottom of each page. Uses the most recent commit touching that file. Individual pages can pin a specific date via the frontmatter timestamp field — see Frontmatter fields.

Show the floating chat bubble on every docs page. Opt-in.

Model identifier — only applied when you bring a matching provider key (BYOK). Without a BYOK key the assistant uses the AI included in your plan and this field is ignored.

Override the default system prompt. Use this to constrain tone, persona, or scope. The platform appends its own RAG context block below your prompt.

Controls group-label click behaviour. When true (default), clicking a group with root set navigates to that page. When false, clicking only toggles expand/collapse.

Whitelist of built-in sections. Accepts "content", "ai-platforms", "mcp", "custom". Omit to show all (default).

Custom menu items appended to the Custom section. href supports $page / $path / $title / $mdx template variables resolved at click time.

Where to render the menu. "toc" placement is queued for a follow-up release and not yet surfaced in the dashboard.