From c6824ab41860fa4e3c865f0a2e2dbe28a604dd76 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Thu, 26 Mar 2026 23:56:40 +0000
Subject: [PATCH] Document navigation properties: tab align, dropdown
description/color, product name/color, public
Generated-By: mintlify-agent
---
organize/navigation.mdx | 46 ++++++++++++++++++++++++++++++---
organize/settings-reference.mdx | 21 ++++++++++-----
organize/settings-structure.mdx | 35 ++++++++++++++++++++++++-
3 files changed, 92 insertions(+), 10 deletions(-)
diff --git a/organize/navigation.mdx b/organize/navigation.mdx
index 16eaceaed..10b936238 100644
--- a/organize/navigation.mdx
+++ b/organize/navigation.mdx
@@ -58,7 +58,7 @@ Use groups to organize your sidebar navigation into sections. You can nest group
alt="Decorative graphic of groups."
/>
-In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, `root`, and `expanded` fields are optional.
+In the `navigation` object, `groups` is an array where each entry is an object that requires a `group` field and a `pages` field. The `icon`, `tag`, `root`, `expanded`, and `public` fields are optional.
```json
{
@@ -141,6 +141,18 @@ Use the `expanded` property to control the default state of a nested group in th
}
```
+### Public groups
+
+Use the `public` property to make all pages in a group publicly accessible when your site uses [authentication](/deploy/authentication-setup). Pages in a public group are visible to all visitors without requiring login.
+
+```json
+{
+ "group": "Getting started",
+ "public": true,
+ "pages": ["quickstart", "installation"]
+}
+```
+
## Tabs
Tabs create distinct sections of your documentation with separate URL paths. Tabs create a horizontal navigation bar at the top of your documentation that lets users switch between sections.
@@ -191,6 +203,30 @@ In the `navigation` object, `tabs` is an array where each entry is an object tha
}
```
+### Tab alignment
+
+Use the `align` property to control where a tab appears in the navigation bar. Set `align` to `"end"` to position a tab at the right side of the tab bar. Tabs default to `"start"` alignment.
+
+```json
+{
+ "navigation": {
+ "tabs": [
+ {
+ "tab": "Documentation",
+ "icon": "book-open",
+ "pages": ["quickstart", "guides"]
+ },
+ {
+ "tab": "API status",
+ "icon": "signal",
+ "align": "end",
+ "href": "https://status.example.com"
+ }
+ ]
+ }
+}
+```
+
### Menus
Menus add dropdown navigation items to a tab. Use menus to help users go directly to specific pages within a tab.
@@ -332,7 +368,7 @@ Global anchors support both external URLs and relative paths to pages within you
Products create a dedicated navigation division for organizing product-specific documentation. Use products to separate different offerings, services, or major feature sets within your documentation.
-In the `navigation` object, `products` is an array where each entry is an object that requires a `product` field and can contain other navigation fields such as groups, pages, icons, or links to external pages.
+In the `navigation` object, `products` is an array where each entry is an object that requires a `product` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. You can also set a `name` to override the display label shown in the product switcher and a `color` to customize the product icon color.
```json
{
@@ -340,8 +376,10 @@ In the `navigation` object, `products` is an array where each entry is an object
"products": [
{
"product": "Core API",
+ "name": "API",
"description": "Core API description",
"icon": "api",
+ "color": { "light": "#0369A1", "dark": "#38BDF8" },
"groups": [
{
"group": "Getting started",
@@ -396,7 +434,7 @@ Dropdowns are an expandable menu at the top of your sidebar navigation. Each ite
alt="Decorative graphic of a dropdown navigation."
/>
-In the `navigation` object, `dropdowns` is an array where each entry is an object that requires a `dropdown` field and can contain other navigation fields such as groups, pages, icons, or links to external pages.
+In the `navigation` object, `dropdowns` is an array where each entry is an object that requires a `dropdown` field and can contain other navigation fields such as groups, pages, icons, or links to external pages. You can also add a `description` and a `color` to customize each dropdown item.
```json
{
@@ -405,6 +443,7 @@ In the `navigation` object, `dropdowns` is an array where each entry is an objec
{
"dropdown": "Documentation",
"icon": "book-open",
+ "description": "Guides and tutorials for getting started.",
"pages": [
"quickstart",
"development",
@@ -414,6 +453,7 @@ In the `navigation` object, `dropdowns` is an array where each entry is an objec
{
"dropdown": "API reference",
"icon": "square-terminal",
+ "color": { "light": "#5B21B6", "dark": "#A78BFA" },
"pages": [
"api-reference/get",
"api-reference/post",
diff --git a/organize/settings-reference.mdx b/organize/settings-reference.mdx
index 7ca283d58..25c44df5d 100644
--- a/organize/settings-reference.mdx
+++ b/organize/settings-reference.mdx
@@ -59,6 +59,7 @@ For context on what each group of settings does, see the topic pages:
| `api.examples.defaults` | `"required"` \| `"all"` | No | `"all"` |
| `api.examples.prefill` | boolean | No | `false` |
| `api.examples.autogenerate` | boolean | No | `true` |
+| `public` | boolean | No | None |
| `seo.indexing` | `"navigable"` \| `"all"` | No | `"navigable"` |
| `seo.metatags` | object | No | None |
| `search.prompt` | string | No | None |
@@ -145,7 +146,7 @@ Global navigation elements that appear across all pages and locales.
Top-level navigation tabs.
-**Type:** array of object—each with: `tab` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `href` (string uri, required)
+**Type:** array of object—each with: `tab` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `align` (`"start"` | `"end"`), `href` (string uri, required)
##### `navigation.global.anchors`
@@ -157,7 +158,7 @@ Sidebar anchor links.
Dropdown menus.
-**Type:** array of object—each with: `dropdown` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `href` (string uri, required)
+**Type:** array of object—each with: `dropdown` (string, required), `icon` (string), `iconType` (string), `description` (string), `color.light` (string hex), `color.dark` (string hex), `hidden` (boolean), `href` (string uri, required)
##### `navigation.global.languages`
@@ -177,7 +178,7 @@ Version switcher in the global nav.
Product switcher in the global nav.
-**Type:** array of object—each with: `product` (string, required), `description` (string), `icon` (string), `iconType` (string)
+**Type:** array of object—each with: `product` (string, required), `name` (string), `description` (string), `icon` (string), `iconType` (string), `color.light` (string hex), `color.dark` (string hex)
#### `navigation.languages`
@@ -195,7 +196,7 @@ Version switcher for multi-version sites.
#### `navigation.tabs`
-Top-level navigation tabs.
+Top-level navigation tabs. Supports an `align` property (`"start"` | `"end"`) to position tabs within the navigation bar.
**Type:** array of object—see `navigation.global.tabs` for shape.
@@ -207,13 +208,13 @@ Sidebar anchor links.
#### `navigation.dropdowns`
-Dropdown menus.
+Dropdown menus. Supports `description` and `color` properties for customization.
**Type:** array of object—see `navigation.global.dropdowns` for shape.
#### `navigation.products`
-Product switcher.
+Product switcher. Supports `name` and `color` properties for customization.
**Type:** array of object—see `navigation.global.products` for shape.
@@ -231,6 +232,14 @@ Individual pages in your documentation.
---
+### `public`
+
+Whether the documentation is publicly accessible by default. Use with [authentication](/deploy/authentication-setup) to control whether pages require login. When set to `true`, all pages are public unless overridden at the group or page level.
+
+**Type:** boolean
+
+---
+
### `description`
Site description for SEO and AI indexing.
diff --git a/organize/settings-structure.mdx b/organize/settings-structure.mdx
index 2c4b920d1..664ac0e1c 100644
--- a/organize/settings-structure.mdx
+++ b/organize/settings-structure.mdx
@@ -30,6 +30,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
Display name of the tab. Minimum length: 1.
+
+ Position the tab at the start or end of the navigation bar. Defaults to `"start"`.
+
Whether to hide this tab by default.
@@ -76,6 +79,21 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
Display name of the dropdown. Minimum length: 1.
+
+ Description text displayed beneath the dropdown name.
+
+
+ Custom colors for the dropdown icon.
+
+
+
+ Dropdown color for light mode. Must be a hex code beginning with `#`.
+
+
+ Dropdown color for dark mode. Must be a hex code beginning with `#`.
+
+
+
Whether to hide this dropdown by default.
@@ -128,12 +146,27 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
- Display name of the product.
+ Identifier for the product.
+
+
+ Display name shown in the product switcher. Defaults to the `product` value.
Description of the product.
+
+ Custom colors for the product icon.
+
+
+
+ Product color for light mode. Must be a hex code beginning with `#`.
+
+
+ Product color for dark mode. Must be a hex code beginning with `#`.
+
+
+